--- diff --git a/a1-policy-management/api/pms-api/index.html b/a1-policy-management/api/offeredapis/openapitoolgen/offeredapis/pms-api/index.html similarity index 72% rename from a1-policy-management/api/pms-api/index.html rename to a1-policy-management/api/offeredapis/openapitoolgen/offeredapis/pms-api/index.html index 66934cda..247549a3 100644 --- a/a1-policy-management/api/pms-api/index.html +++ b/a1-policy-management/api/offeredapis/openapitoolgen/offeredapis/pms-api/index.html @@ -7,10 +7,8 @@ @@ -1197,46 +1196,6 @@ ul.nav-tabs {

putPolicy

- -

- health -

- healthPath -

- heapdump -

- info -

- links -

- logfile -

- loggers -

- loggersName -

- loggersName2 -

- metrics -

- metricsRequiredMetricName -

- shutdown -

- threaddump -

performAccessControl @@ -1318,6 +1277,7 @@ ul.nav-tabs {

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String policyId = new String(); // String | 
+
+try {
+    final result = await api_instance.deletePolicy(policyId);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->deletePolicy: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-A1PolicyManagement-deletePolicy-200-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-A1PolicyManagement-deletePolicy-schema-200'); + result.empty(); + result.append(view.render()); + }); +

+ +

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-A1PolicyManagement-deletePolicy-423-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-A1PolicyManagement-deletePolicy-schema-423'); + result.empty(); + result.append(view.render()); + }); +

+ +

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String policyId = new String(); // String | 
+
+try {
+    final result = await api_instance.getPolicy(policyId);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getPolicy: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-A1PolicyManagement-getPolicy-200-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-A1PolicyManagement-getPolicy-schema-200'); + result.empty(); + result.append(view.render()); + }); +

+ +

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String policytypeId = new String(); // String | Select policies of a given policy type identity.
+final String ricId = new String(); // String | Select policies of a given Near-RT RIC identity.
+final String serviceId = new String(); // String | Select policies owned by a given service.
+final String typeName = new String(); // String | Select policies of types with the given type name (type identity has the format )
+
+try {
+    final result = await api_instance.getPolicyIds(policytypeId, ricId, serviceId, typeName);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getPolicyIds: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-A1PolicyManagement-getPolicyIds-200-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-A1PolicyManagement-getPolicyIds-schema-200'); + result.empty(); + result.append(view.render()); + }); +

+ +

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String policytypeId = new String(); // String | Select policies with a given type identity.
+final String ricId = new String(); // String | Select policies for a given Near-RT RIC identity.
+final String serviceId = new String(); // String | Select policies owned by a given service.
+final String typeName = new String(); // String | Select policies of a given type name (type identity has the format )
+
+try {
+    final result = await api_instance.getPolicyInstances(policytypeId, ricId, serviceId, typeName);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getPolicyInstances: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-A1PolicyManagement-getPolicyInstances-200-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-A1PolicyManagement-getPolicyInstances-schema-200'); + result.empty(); + result.append(view.render()); + }); +

+ +

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-A1PolicyManagement-getPolicyInstances-404-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-A1PolicyManagement-getPolicyInstances-schema-404'); + result.empty(); + result.append(view.render()); + }); +

+ +

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String policyId = new String(); // String | 
+
+try {
+    final result = await api_instance.getPolicyStatus(policyId);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getPolicyStatus: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-A1PolicyManagement-getPolicyStatus-200-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-A1PolicyManagement-getPolicyStatus-schema-200'); + result.empty(); + result.append(view.render()); + }); +

+ +

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String policytypeId = new String(); // String | 
+
+try {
+    final result = await api_instance.getPolicyTypeDefinition(policytypeId);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getPolicyTypeDefinition: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-A1PolicyManagement-getPolicyTypeDefinition-200-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-A1PolicyManagement-getPolicyTypeDefinition-schema-200'); + result.empty(); + result.append(view.render()); + }); +

+ +

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String ricId = new String(); // String | Select types for the given Near-RT RIC identity.
+final String typeName = new String(); // String | Select types with the given type name (type identity has the format )
+final String compatibleWithVersion = new String(); // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order.
+
+try {
+    final result = await api_instance.getPolicyTypes(ricId, typeName, compatibleWithVersion);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getPolicyTypes: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-A1PolicyManagement-getPolicyTypes-200-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-A1PolicyManagement-getPolicyTypes-schema-200'); + result.empty(); + result.append(view.render()); + }); +

+ +

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final PolicyInfo policyInfo = new PolicyInfo(); // PolicyInfo | 
+
+try {
+    final result = await api_instance.putPolicy(policyInfo);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->putPolicy: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-A1PolicyManagement-putPolicy-201-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-A1PolicyManagement-putPolicy-schema-201'); + result.empty(); + result.append(view.render()); + }); +

+ +

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-A1PolicyManagement-putPolicy-423-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-A1PolicyManagement-putPolicy-schema-423'); + result.empty(); + result.append(view.render()); + }); +

+ +

Actuator

AuthorizationAPI

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

- - - -

- Schema -

- - -

- -

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

- - - -

- Schema -

- - -

- -

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

- - - -

- Schema -

- - -

- -

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

- - - -

- Schema -

- - -

- -

links

Actuator root web endpoint

-
-

/actuator

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"
-

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 {
-            map['String', map['String', Link]] result = apiInstance.links();
-            System.out.println(result);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling ActuatorApi#links");
-            e.printStackTrace();
-        }
-    }
-}
-

- -

import org.openapitools.client.api.ActuatorApi;
-
-public class ActuatorApiExample {
-    public static void main(String[] args) {
-        ActuatorApi apiInstance = new ActuatorApi();
-
-        try {
-            map['String', map['String', Link]] result = apiInstance.links();
-            System.out.println(result);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling ActuatorApi#links");
-            e.printStackTrace();
-        }
-    }
-}

- -


-
-// Create an instance of the API class
-ActuatorApi *apiInstance = [[ActuatorApi alloc] init];
-
-// Actuator root web endpoint
-[apiInstance linksWithCompletionHandler: 
-              ^(map['String', map['String', Link]] 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.links(callback);
-

- - -

using System;
-using System.Diagnostics;
-using Org.OpenAPITools.Api;
-using Org.OpenAPITools.Client;
-using Org.OpenAPITools.Model;
-
-namespace Example
-{
-    public class linksExample
-    {
-        public void main()
-        {
-
-            // Create an instance of the API class
-            var apiInstance = new ActuatorApi();
-
-            try {
-                // Actuator root web endpoint
-                map['String', map['String', Link]] result = apiInstance.links();
-                Debug.WriteLine(result);
-            } catch (Exception e) {
-                Debug.Print("Exception when calling ActuatorApi.links: " + 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->links();
-    print_r($result);
-} catch (Exception $e) {
-    echo 'Exception when calling ActuatorApi->links: ', $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->links();
-    print Dumper($result);
-};
-if ($@) {
-    warn "Exception when calling ActuatorApi->links: $@\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 root web endpoint
-    api_response = api_instance.links()
-    pprint(api_response)
-except ApiException as e:
-    print("Exception when calling ActuatorApi->links: %s\n" % e)

- -

extern crate ActuatorApi;
-
-pub fn main() {
-
-    let mut context = ActuatorApi::Context::default();
-    let result = client.links(&context).wait();
-
-    println!("{:?}", result);
-}
-

- -

Scopes

- - -

- -

Parameters

- - - - - - -

Responses

- - - -

- Schema -

- - -

- -

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

- - - -

- Schema -

- - -

- -

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

- - - -

- Schema -

- - -

- -

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

- - - -

- Schema -

- - -

- -

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

- - - -

- Schema -

- - -

- -

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

- - - -

- Schema -

- - -

- -

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

- - - -

- Schema -

- - -

- -

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

- - - -

- Schema -

- - -

- -

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

- - - -

- Schema -

- - -

- -

AuthorizationAPI

performAccessControl

Request for access authorization.

performAccessControl

Request for access authorization.

@@ -8638,6 +5159,7 @@ pub fn main() {

Curl
Java
Dart
Android
Obj-C

+ +

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final PolicyAuthorization policyAuthorization = new PolicyAuthorization(); // PolicyAuthorization | 
+
+try {
+    final result = await api_instance.performAccessControl(policyAuthorization);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->performAccessControl: $e\n');
+}
+

@@ -8870,15 +5409,15 @@ pub fn main() {

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-AuthorizationAPI-performAccessControl-200-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-AuthorizationAPI-performAccessControl-schema-200'); + result.empty(); + result.append(view.render()); + }); + + +

@@ -8997,41 +5552,60 @@ $(document).ready(function() {

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-AuthorizationAPI-performAccessControl-403-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-AuthorizationAPI-performAccessControl-schema-403'); + result.empty(); + result.append(view.render()); + }); +

+ +

@@ -9058,6 +5632,7 @@ $(document).ready(function() {

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+
+try {
+    final result = await api_instance.getConfiguration();
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getConfiguration: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-Configuration-getConfiguration-200-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-Configuration-getConfiguration-schema-200'); + result.empty(); + result.append(view.render()); + }); +

+ +

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final Object body = new Object(); // Object | 
+
+try {
+    final result = await api_instance.putConfiguration(body);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->putConfiguration: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-Configuration-putConfiguration-400-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-Configuration-putConfiguration-schema-400'); + result.empty(); + result.append(view.render()); + }); +

+ +

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+
+try {
+    final result = await api_instance.getStatus();
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getStatus: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-HealthCheck-getStatus-200-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-HealthCheck-getStatus-schema-200'); + result.empty(); + result.append(view.render()); + }); +

+ +

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+
+try {
+    final result = await api_instance.getStatusV1();
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getStatusV1: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-HealthCheck-getStatusV1-200-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-HealthCheck-getStatusV1-schema-200'); + result.empty(); + result.append(view.render()); + }); +

+ +

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String managedElementId = new String(); // String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
+final String ricId = new String(); // String | The identity of a Near-RT RIC to get information for.
+
+try {
+    final result = await api_instance.getRic(managedElementId, ricId);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getRic: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-NearRTRICRepository-getRic-200-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-NearRTRICRepository-getRic-schema-200'); + result.empty(); + result.append(view.render()); + }); +

+ +

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String policytypeId = new String(); // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
+
+try {
+    final result = await api_instance.getRics(policytypeId);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getRics: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-NearRTRICRepository-getRics-200-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-NearRTRICRepository-getRics-schema-200'); + result.empty(); + result.append(view.render()); + }); +

+ +

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String serviceId = new String(); // String | 
+
+try {
+    final result = await api_instance.deleteService(serviceId);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->deleteService: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-ServiceRegistryAndSupervision-deleteService-204-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-ServiceRegistryAndSupervision-deleteService-schema-204'); + result.empty(); + result.append(view.render()); + }); +

+ +

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String serviceId = new String(); // String | The identity of the service
+
+try {
+    final result = await api_instance.getServices(serviceId);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getServices: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-ServiceRegistryAndSupervision-getServices-200-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-ServiceRegistryAndSupervision-getServices-schema-200'); + result.empty(); + result.append(view.render()); + }); +

+ +

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String serviceId = new String(); // String | 
+
+try {
+    final result = await api_instance.keepAliveService(serviceId);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->keepAliveService: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-ServiceRegistryAndSupervision-keepAliveService-200-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-ServiceRegistryAndSupervision-keepAliveService-schema-200'); + result.empty(); + result.append(view.render()); + }); +

+ +

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final ServiceRegistrationInfo serviceRegistrationInfo = new ServiceRegistrationInfo(); // ServiceRegistrationInfo | 
+
+try {
+    final result = await api_instance.putService(serviceRegistrationInfo);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->putService: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-ServiceRegistryAndSupervision-putService-201-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-ServiceRegistryAndSupervision-putService-schema-201'); + result.empty(); + result.append(view.render()); + }); +

+ +

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-ServiceRegistryAndSupervision-putService-400-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-ServiceRegistryAndSupervision-putService-schema-400'); + result.empty(); + result.append(view.render()); + }); +

+ +

A1 policy management API

+ +

A1 policy management API

API and SDK Documentation

Version: 1.0.0

General

The O-RAN Non-RT RIC Policy Management Service provides a REST API for managemecnt of A1 policies.
The main tasks of the service are:

A1 Policy creation, modification and deletion.
Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs
Maintaining a view of supported Near-RT RIC policy types
Supervision of using services (R-APPs). When a service is unavailable, its policies are removed.

APIs provided or defined by the service

A1 Policy Management

This is an API for management of A1 Policies.

A1 Policy retrieval, creation, modification and deletion.
Retrieval of supported A1 Policy types for a Near-RT RIC
Retrieval of status for existing A1 policies

Management of configuration

API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.

Service callbacks

These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.

NearRT-RIC Repository

This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted for one Near-RT RIC.

Health Check

API used for supervision of the PMS component.

Service Registry and Supervision

API used for registering services that uses PMS. Each A1 policy is optionally owned by a service. PMS can supervise each registered service by a heart-beat supervision and will automatically remove policies for unavailable services. Note that a service does not need to be registered in order to create A1 Policies. This is a feature that is optional to use.

Authorization API

API used for access control of A1 Policy access. If configured, an external authorization provider is requested to grant access to the A1 Policy type.

+ +

A1PolicyManagement

createPolicy

To create A1 policies

+
+

/policies

Usage and SDK Samples

+ +

curl -X POST \
+ -H "Accept: application/json,application/problem+json" \
+ -H "Content-Type: application/json" \
+ "https://example.com/a1-policy-management/v1/policies" \
+ -d '{
+  "policyId" : "POLICY-ID",
+  "nearRtRicId" : "Near-RT-Ric-ID",
+  "transient" : false,
+  "policyObject" : "{}",
+  "serviceId" : "rApp ID",
+  "policyTypeId" : "ORAN_QOS_1.0.0(typeName_SemVersion)"
+}'
+

import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.A1PolicyManagementApi;
+
+import java.io.File;
+import java.util.*;
+
+public class A1PolicyManagementApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
+        PolicyObjectInformation policyObjectInformation = ; // PolicyObjectInformation | 
+
+        try {
+            PolicyObjectInformation result = apiInstance.createPolicy(policyObjectInformation);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling A1PolicyManagementApi#createPolicy");
+            e.printStackTrace();
+        }
+    }
+}
+

+ +

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final PolicyObjectInformation policyObjectInformation = new PolicyObjectInformation(); // PolicyObjectInformation | 
+
+try {
+    final result = await api_instance.createPolicy(policyObjectInformation);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->createPolicy: $e\n');
+}
+
+

+ +

import org.openapitools.client.api.A1PolicyManagementApi;
+
+public class A1PolicyManagementApiExample {
+    public static void main(String[] args) {
+        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
+        PolicyObjectInformation policyObjectInformation = ; // PolicyObjectInformation | 
+
+        try {
+            PolicyObjectInformation result = apiInstance.createPolicy(policyObjectInformation);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling A1PolicyManagementApi#createPolicy");
+            e.printStackTrace();
+        }
+    }
+}

+ +


+
+// Create an instance of the API class
+A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
+PolicyObjectInformation *policyObjectInformation = ; // 
+
+[apiInstance createPolicyWith:policyObjectInformation
+              completionHandler: ^(PolicyObjectInformation output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+

+ +

var A1PolicyManagementApi = require('a1_policy_management_api');
+
+// Create an instance of the API class
+var api = new A1PolicyManagementApi.A1PolicyManagementApi()
+var policyObjectInformation = ; // {PolicyObjectInformation} 
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.createPolicy(policyObjectInformation, callback);
+

+ + +

using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class createPolicyExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new A1PolicyManagementApi();
+            var policyObjectInformation = new PolicyObjectInformation(); // PolicyObjectInformation | 
+
+            try {
+                PolicyObjectInformation result = apiInstance.createPolicy(policyObjectInformation);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling A1PolicyManagementApi.createPolicy: " + e.Message );
+            }
+        }
+    }
+}
+

+ +

<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\A1PolicyManagementApi();
+$policyObjectInformation = ; // PolicyObjectInformation | 
+
+try {
+    $result = $api_instance->createPolicy($policyObjectInformation);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling A1PolicyManagementApi->createPolicy: ', $e->getMessage(), PHP_EOL;
+}
+?>

+ +

use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::A1PolicyManagementApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::A1PolicyManagementApi->new();
+my $policyObjectInformation = WWW::OPenAPIClient::Object::PolicyObjectInformation->new(); # PolicyObjectInformation | 
+
+eval {
+    my $result = $api_instance->createPolicy(policyObjectInformation => $policyObjectInformation);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling A1PolicyManagementApi->createPolicy: $@\n";
+}

+ +

from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.A1PolicyManagementApi()
+policyObjectInformation =  # PolicyObjectInformation | 
+
+try:
+    api_response = api_instance.create_policy(policyObjectInformation)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling A1PolicyManagementApi->createPolicy: %s\n" % e)

+ +

extern crate A1PolicyManagementApi;
+
+pub fn main() {
+    let policyObjectInformation = ; // PolicyObjectInformation
+
+    let mut context = A1PolicyManagementApi::Context::default();
+    let result = client.createPolicy(policyObjectInformation, &context).wait();
+
+    println!("{:?}", result);
+}
+

+ +

Scopes

+ + +

+ +

Parameters

+ + + +

Body parameters

+ + + + + + + + + +

Name	Description
policyObjectInformation *	+ + + +

+ + + +

Responses

+ + + +

+ Schema +
+ Headers +

+ + +

+ +

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

Name	Type	Format	Description
Location	String		Contains the URI of the newly created resource

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

deletePolicy

Delete a policy

Deleting the policy using policyId.

+
+

/policies/{policyId}

Usage and SDK Samples

+ +

curl -X DELETE \
+ -H "Accept: application/problem+json" \
+ "https://example.com/a1-policy-management/v1/policies/{policyId}"
+

import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.A1PolicyManagementApi;
+
+import java.io.File;
+import java.util.*;
+
+public class A1PolicyManagementApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
+        String policyId = policyId_example; // String | 
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            apiInstance.deletePolicy(policyId, accept);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling A1PolicyManagementApi#deletePolicy");
+            e.printStackTrace();
+        }
+    }
+}
+

+ +

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String policyId = new String(); // String | 
+final String accept = new String(); // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    final result = await api_instance.deletePolicy(policyId, accept);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->deletePolicy: $e\n');
+}
+
+

+ +

import org.openapitools.client.api.A1PolicyManagementApi;
+
+public class A1PolicyManagementApiExample {
+    public static void main(String[] args) {
+        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
+        String policyId = policyId_example; // String | 
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            apiInstance.deletePolicy(policyId, accept);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling A1PolicyManagementApi#deletePolicy");
+            e.printStackTrace();
+        }
+    }
+}

+ +


+
+// Create an instance of the API class
+A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
+String *policyId = policyId_example; //  (default to null)
+String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+// Delete a policy
+[apiInstance deletePolicyWith:policyId
+    accept:accept
+              completionHandler: ^(NSError* error) {
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+

+ +

var A1PolicyManagementApi = require('a1_policy_management_api');
+
+// Create an instance of the API class
+var api = new A1PolicyManagementApi.A1PolicyManagementApi()
+var policyId = policyId_example; // {String} 
+var opts = {
+  'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.deletePolicy(policyId, opts, callback);
+

+ + +

using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class deletePolicyExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new A1PolicyManagementApi();
+            var policyId = policyId_example;  // String |  (default to null)
+            var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)
+
+            try {
+                // Delete a policy
+                apiInstance.deletePolicy(policyId, accept);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling A1PolicyManagementApi.deletePolicy: " + e.Message );
+            }
+        }
+    }
+}
+

+ +

<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\A1PolicyManagementApi();
+$policyId = policyId_example; // String | 
+$accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    $api_instance->deletePolicy($policyId, $accept);
+} catch (Exception $e) {
+    echo 'Exception when calling A1PolicyManagementApi->deletePolicy: ', $e->getMessage(), PHP_EOL;
+}
+?>

+ +

use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::A1PolicyManagementApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::A1PolicyManagementApi->new();
+my $policyId = policyId_example; # String | 
+my $accept = application/json; # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+eval {
+    $api_instance->deletePolicy(policyId => $policyId, accept => $accept);
+};
+if ($@) {
+    warn "Exception when calling A1PolicyManagementApi->deletePolicy: $@\n";
+}

+ +

from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.A1PolicyManagementApi()
+policyId = policyId_example # String |  (default to null)
+accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+try:
+    # Delete a policy
+    api_instance.delete_policy(policyId, accept=accept)
+except ApiException as e:
+    print("Exception when calling A1PolicyManagementApi->deletePolicy: %s\n" % e)

+ +

extern crate A1PolicyManagementApi;
+
+pub fn main() {
+    let policyId = policyId_example; // String
+    let accept = application/json; // String
+
+    let mut context = A1PolicyManagementApi::Context::default();
+    let result = client.deletePolicy(policyId, accept, &context).wait();
+
+    println!("{:?}", result);
+}
+

+ +

Scopes

+ + +

+ +

Parameters

+ +

Path parameters

+ + + + + + + + + +

Name	Description
policyId*	+ + + + + + + String + + + + + Required + + + +

+ +

Header parameters

+ + + + + + + + + +

Name	Description
Accept	+ + + + + + + String + + + +Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. + + + + +

+ + + + +

Responses

+ + + +

+ + + + + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

getAllPolicies

Query policy identities

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

+
+

/policies

Usage and SDK Samples

+ +

curl -X GET \
+ -H "Accept: application/json,application/problem+json" \
+ "https://example.com/a1-policy-management/v1/policies?policyTypeId=policyTypeId_example&nearRtRicId=nearRtRicId_example&serviceId=serviceId_example&typeName=typeName_example"
+

import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.A1PolicyManagementApi;
+
+import java.io.File;
+import java.util.*;
+
+public class A1PolicyManagementApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
+        String policyTypeId = policyTypeId_example; // String | Select policies of a given policy type identity.
+        String nearRtRicId = nearRtRicId_example; // String | Select policies of a given Near-RT RIC identity.
+        String serviceId = serviceId_example; // String | Select policies owned by a given service.
+        String typeName = typeName_example; // String | Select policies of types with the given type name (type identity has the format )
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            array[PolicyInformation] result = apiInstance.getAllPolicies(policyTypeId, nearRtRicId, serviceId, typeName, accept);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling A1PolicyManagementApi#getAllPolicies");
+            e.printStackTrace();
+        }
+    }
+}
+

+ +

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String policyTypeId = new String(); // String | Select policies of a given policy type identity.
+final String nearRtRicId = new String(); // String | Select policies of a given Near-RT RIC identity.
+final String serviceId = new String(); // String | Select policies owned by a given service.
+final String typeName = new String(); // String | Select policies of types with the given type name (type identity has the format )
+final String accept = new String(); // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    final result = await api_instance.getAllPolicies(policyTypeId, nearRtRicId, serviceId, typeName, accept);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getAllPolicies: $e\n');
+}
+
+

+ +

import org.openapitools.client.api.A1PolicyManagementApi;
+
+public class A1PolicyManagementApiExample {
+    public static void main(String[] args) {
+        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
+        String policyTypeId = policyTypeId_example; // String | Select policies of a given policy type identity.
+        String nearRtRicId = nearRtRicId_example; // String | Select policies of a given Near-RT RIC identity.
+        String serviceId = serviceId_example; // String | Select policies owned by a given service.
+        String typeName = typeName_example; // String | Select policies of types with the given type name (type identity has the format )
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            array[PolicyInformation] result = apiInstance.getAllPolicies(policyTypeId, nearRtRicId, serviceId, typeName, accept);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling A1PolicyManagementApi#getAllPolicies");
+            e.printStackTrace();
+        }
+    }
+}

+ +


+
+// Create an instance of the API class
+A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
+String *policyTypeId = policyTypeId_example; // Select policies of a given policy type identity. (optional) (default to null)
+String *nearRtRicId = nearRtRicId_example; // Select policies of a given Near-RT RIC identity. (optional) (default to null)
+String *serviceId = serviceId_example; // Select policies owned by a given service. (optional) (default to null)
+String *typeName = typeName_example; // Select policies of types with the given type name (type identity has the format ) (optional) (default to null)
+String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+// Query policy identities
+[apiInstance getAllPoliciesWith:policyTypeId
+    nearRtRicId:nearRtRicId
+    serviceId:serviceId
+    typeName:typeName
+    accept:accept
+              completionHandler: ^(array[PolicyInformation] output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+

+ +

var A1PolicyManagementApi = require('a1_policy_management_api');
+
+// Create an instance of the API class
+var api = new A1PolicyManagementApi.A1PolicyManagementApi()
+var opts = {
+  'policyTypeId': policyTypeId_example, // {String} Select policies of a given policy type identity.
+  'nearRtRicId': nearRtRicId_example, // {String} Select policies of a given Near-RT RIC identity.
+  'serviceId': serviceId_example, // {String} Select policies owned by a given service.
+  'typeName': typeName_example, // {String} Select policies of types with the given type name (type identity has the format )
+  'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getAllPolicies(opts, callback);
+

+ + +

using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class getAllPoliciesExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new A1PolicyManagementApi();
+            var policyTypeId = policyTypeId_example;  // String | Select policies of a given policy type identity. (optional)  (default to null)
+            var nearRtRicId = nearRtRicId_example;  // String | Select policies of a given Near-RT RIC identity. (optional)  (default to null)
+            var serviceId = serviceId_example;  // String | Select policies owned by a given service. (optional)  (default to null)
+            var typeName = typeName_example;  // String | Select policies of types with the given type name (type identity has the format ) (optional)  (default to null)
+            var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)
+
+            try {
+                // Query policy identities
+                array[PolicyInformation] result = apiInstance.getAllPolicies(policyTypeId, nearRtRicId, serviceId, typeName, accept);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling A1PolicyManagementApi.getAllPolicies: " + e.Message );
+            }
+        }
+    }
+}
+

+ +

<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\A1PolicyManagementApi();
+$policyTypeId = policyTypeId_example; // String | Select policies of a given policy type identity.
+$nearRtRicId = nearRtRicId_example; // String | Select policies of a given Near-RT RIC identity.
+$serviceId = serviceId_example; // String | Select policies owned by a given service.
+$typeName = typeName_example; // String | Select policies of types with the given type name (type identity has the format )
+$accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    $result = $api_instance->getAllPolicies($policyTypeId, $nearRtRicId, $serviceId, $typeName, $accept);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling A1PolicyManagementApi->getAllPolicies: ', $e->getMessage(), PHP_EOL;
+}
+?>

+ +

use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::A1PolicyManagementApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::A1PolicyManagementApi->new();
+my $policyTypeId = policyTypeId_example; # String | Select policies of a given policy type identity.
+my $nearRtRicId = nearRtRicId_example; # String | Select policies of a given Near-RT RIC identity.
+my $serviceId = serviceId_example; # String | Select policies owned by a given service.
+my $typeName = typeName_example; # String | Select policies of types with the given type name (type identity has the format )
+my $accept = application/json; # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+eval {
+    my $result = $api_instance->getAllPolicies(policyTypeId => $policyTypeId, nearRtRicId => $nearRtRicId, serviceId => $serviceId, typeName => $typeName, accept => $accept);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling A1PolicyManagementApi->getAllPolicies: $@\n";
+}

+ +

from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.A1PolicyManagementApi()
+policyTypeId = policyTypeId_example # String | Select policies of a given policy type identity. (optional) (default to null)
+nearRtRicId = nearRtRicId_example # String | Select policies of a given Near-RT RIC identity. (optional) (default to null)
+serviceId = serviceId_example # String | Select policies owned by a given service. (optional) (default to null)
+typeName = typeName_example # String | Select policies of types with the given type name (type identity has the format ) (optional) (default to null)
+accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+try:
+    # Query policy identities
+    api_response = api_instance.get_all_policies(policyTypeId=policyTypeId, nearRtRicId=nearRtRicId, serviceId=serviceId, typeName=typeName, accept=accept)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling A1PolicyManagementApi->getAllPolicies: %s\n" % e)

+ +

extern crate A1PolicyManagementApi;
+
+pub fn main() {
+    let policyTypeId = policyTypeId_example; // String
+    let nearRtRicId = nearRtRicId_example; // String
+    let serviceId = serviceId_example; // String
+    let typeName = typeName_example; // String
+    let accept = application/json; // String
+
+    let mut context = A1PolicyManagementApi::Context::default();
+    let result = client.getAllPolicies(policyTypeId, nearRtRicId, serviceId, typeName, accept, &context).wait();
+
+    println!("{:?}", result);
+}
+

+ +

Scopes

+ + +

+ +

Parameters

+ + +

Header parameters

+ + + + + + + + + +

Name	Description
Accept	+ + + + + + + String + + + +Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. + + + + +

+ + + +

Query parameters

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

Name	Description
policyTypeId	+ + + + + + + String + + + +Select policies of a given policy type identity. + + + + +
nearRtRicId	+ + + + + + + String + + + +Select policies of a given Near-RT RIC identity. + + + + +
serviceId	+ + + + + + + String + + + +Select policies owned by a given service. + + + + +
typeName	+ + + + + + + String + + + +Select policies of types with the given type name (type identity has the format <typename_version>) + + + + +

+ +

Responses

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

getPolicy

Returns a policy

+
+

/policies/{policyId}

Usage and SDK Samples

+ +

curl -X GET \
+ -H "Accept: application/json,application/problem+json" \
+ "https://example.com/a1-policy-management/v1/policies/{policyId}"
+

import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.A1PolicyManagementApi;
+
+import java.io.File;
+import java.util.*;
+
+public class A1PolicyManagementApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
+        String policyId = policyId_example; // String | 
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            Object result = apiInstance.getPolicy(policyId, accept);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling A1PolicyManagementApi#getPolicy");
+            e.printStackTrace();
+        }
+    }
+}
+

+ +

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String policyId = new String(); // String | 
+final String accept = new String(); // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    final result = await api_instance.getPolicy(policyId, accept);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getPolicy: $e\n');
+}
+
+

+ +

import org.openapitools.client.api.A1PolicyManagementApi;
+
+public class A1PolicyManagementApiExample {
+    public static void main(String[] args) {
+        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
+        String policyId = policyId_example; // String | 
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            Object result = apiInstance.getPolicy(policyId, accept);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling A1PolicyManagementApi#getPolicy");
+            e.printStackTrace();
+        }
+    }
+}

+ +


+
+// Create an instance of the API class
+A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
+String *policyId = policyId_example; //  (default to null)
+String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+[apiInstance getPolicyWith:policyId
+    accept:accept
+              completionHandler: ^(Object output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+

+ +

var A1PolicyManagementApi = require('a1_policy_management_api');
+
+// Create an instance of the API class
+var api = new A1PolicyManagementApi.A1PolicyManagementApi()
+var policyId = policyId_example; // {String} 
+var opts = {
+  'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getPolicy(policyId, opts, callback);
+

+ + +

using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class getPolicyExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new A1PolicyManagementApi();
+            var policyId = policyId_example;  // String |  (default to null)
+            var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)
+
+            try {
+                Object result = apiInstance.getPolicy(policyId, accept);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling A1PolicyManagementApi.getPolicy: " + e.Message );
+            }
+        }
+    }
+}
+

+ +

<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\A1PolicyManagementApi();
+$policyId = policyId_example; // String | 
+$accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    $result = $api_instance->getPolicy($policyId, $accept);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling A1PolicyManagementApi->getPolicy: ', $e->getMessage(), PHP_EOL;
+}
+?>

+ +

use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::A1PolicyManagementApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::A1PolicyManagementApi->new();
+my $policyId = policyId_example; # String | 
+my $accept = application/json; # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+eval {
+    my $result = $api_instance->getPolicy(policyId => $policyId, accept => $accept);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling A1PolicyManagementApi->getPolicy: $@\n";
+}

+ +

from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.A1PolicyManagementApi()
+policyId = policyId_example # String |  (default to null)
+accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+try:
+    api_response = api_instance.get_policy(policyId, accept=accept)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling A1PolicyManagementApi->getPolicy: %s\n" % e)

+ +

extern crate A1PolicyManagementApi;
+
+pub fn main() {
+    let policyId = policyId_example; // String
+    let accept = application/json; // String
+
+    let mut context = A1PolicyManagementApi::Context::default();
+    let result = client.getPolicy(policyId, accept, &context).wait();
+
+    println!("{:?}", result);
+}
+

+ +

Scopes

+ + +

+ +

Parameters

+ +

Path parameters

+ + + + + + + + + +

Name	Description
policyId*	+ + + + + + + String + + + + + Required + + + +

+ +

Header parameters

+ + + + + + + + + +

Name	Description
Accept	+ + + + + + + String + + + +Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. + + + + +

+ + + + +

Responses

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

getPolicyTypeDefinition

Returns a policy type definition

+
+

/policy-types/{policyTypeId}

Usage and SDK Samples

+ +

curl -X GET \
+ -H "Accept: application/json,application/problem+json" \
+ "https://example.com/a1-policy-management/v1/policy-types/{policyTypeId}"
+

import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.A1PolicyManagementApi;
+
+import java.io.File;
+import java.util.*;
+
+public class A1PolicyManagementApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
+        String policyTypeId = policyTypeId_example; // String | 
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            Object result = apiInstance.getPolicyTypeDefinition(policyTypeId, accept);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling A1PolicyManagementApi#getPolicyTypeDefinition");
+            e.printStackTrace();
+        }
+    }
+}
+

+ +

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String policyTypeId = new String(); // String | 
+final String accept = new String(); // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    final result = await api_instance.getPolicyTypeDefinition(policyTypeId, accept);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getPolicyTypeDefinition: $e\n');
+}
+
+

+ +

import org.openapitools.client.api.A1PolicyManagementApi;
+
+public class A1PolicyManagementApiExample {
+    public static void main(String[] args) {
+        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
+        String policyTypeId = policyTypeId_example; // String | 
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            Object result = apiInstance.getPolicyTypeDefinition(policyTypeId, accept);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling A1PolicyManagementApi#getPolicyTypeDefinition");
+            e.printStackTrace();
+        }
+    }
+}

+ +


+
+// Create an instance of the API class
+A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
+String *policyTypeId = policyTypeId_example; //  (default to null)
+String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+[apiInstance getPolicyTypeDefinitionWith:policyTypeId
+    accept:accept
+              completionHandler: ^(Object output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+

+ +

var A1PolicyManagementApi = require('a1_policy_management_api');
+
+// Create an instance of the API class
+var api = new A1PolicyManagementApi.A1PolicyManagementApi()
+var policyTypeId = policyTypeId_example; // {String} 
+var opts = {
+  'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getPolicyTypeDefinition(policyTypeId, opts, callback);
+

+ + +

using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class getPolicyTypeDefinitionExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new A1PolicyManagementApi();
+            var policyTypeId = policyTypeId_example;  // String |  (default to null)
+            var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)
+
+            try {
+                Object result = apiInstance.getPolicyTypeDefinition(policyTypeId, accept);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling A1PolicyManagementApi.getPolicyTypeDefinition: " + e.Message );
+            }
+        }
+    }
+}
+

+ +

<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\A1PolicyManagementApi();
+$policyTypeId = policyTypeId_example; // String | 
+$accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    $result = $api_instance->getPolicyTypeDefinition($policyTypeId, $accept);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling A1PolicyManagementApi->getPolicyTypeDefinition: ', $e->getMessage(), PHP_EOL;
+}
+?>

+ +

use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::A1PolicyManagementApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::A1PolicyManagementApi->new();
+my $policyTypeId = policyTypeId_example; # String | 
+my $accept = application/json; # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+eval {
+    my $result = $api_instance->getPolicyTypeDefinition(policyTypeId => $policyTypeId, accept => $accept);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling A1PolicyManagementApi->getPolicyTypeDefinition: $@\n";
+}

+ +

from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.A1PolicyManagementApi()
+policyTypeId = policyTypeId_example # String |  (default to null)
+accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+try:
+    api_response = api_instance.get_policy_type_definition(policyTypeId, accept=accept)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling A1PolicyManagementApi->getPolicyTypeDefinition: %s\n" % e)

+ +

extern crate A1PolicyManagementApi;
+
+pub fn main() {
+    let policyTypeId = policyTypeId_example; // String
+    let accept = application/json; // String
+
+    let mut context = A1PolicyManagementApi::Context::default();
+    let result = client.getPolicyTypeDefinition(policyTypeId, accept, &context).wait();
+
+    println!("{:?}", result);
+}
+

+ +

Scopes

+ + +

+ +

Parameters

+ +

Path parameters

+ + + + + + + + + +

Name	Description
policyTypeId*	+ + + + + + + String + + + + + Required + + + +

+ +

Header parameters

+ + + + + + + + + +

Name	Description
Accept	+ + + + + + + String + + + +Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. + + + + +

+ + + + +

Responses

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

getPolicyTypes

Query policy type identities

+
+

/policy-types

Usage and SDK Samples

+ +

curl -X GET \
+ -H "Accept: application/json,application/problem+json" \
+ "https://example.com/a1-policy-management/v1/policy-types?nearRtRicId=nearRtRicId_example&typeName=typeName_example&compatibleWithVersion=compatibleWithVersion_example"
+

import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.A1PolicyManagementApi;
+
+import java.io.File;
+import java.util.*;
+
+public class A1PolicyManagementApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
+        String nearRtRicId = nearRtRicId_example; // String | Select types for the given Near-RT RIC identity.
+        String typeName = typeName_example; // String | Select types with the given type name (type identity has the format )
+        String compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order.
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            array[PolicyTypeInformation] result = apiInstance.getPolicyTypes(nearRtRicId, typeName, compatibleWithVersion, accept);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling A1PolicyManagementApi#getPolicyTypes");
+            e.printStackTrace();
+        }
+    }
+}
+

+ +

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String nearRtRicId = new String(); // String | Select types for the given Near-RT RIC identity.
+final String typeName = new String(); // String | Select types with the given type name (type identity has the format )
+final String compatibleWithVersion = new String(); // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order.
+final String accept = new String(); // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    final result = await api_instance.getPolicyTypes(nearRtRicId, typeName, compatibleWithVersion, accept);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getPolicyTypes: $e\n');
+}
+
+

+ +

import org.openapitools.client.api.A1PolicyManagementApi;
+
+public class A1PolicyManagementApiExample {
+    public static void main(String[] args) {
+        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
+        String nearRtRicId = nearRtRicId_example; // String | Select types for the given Near-RT RIC identity.
+        String typeName = typeName_example; // String | Select types with the given type name (type identity has the format )
+        String compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order.
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            array[PolicyTypeInformation] result = apiInstance.getPolicyTypes(nearRtRicId, typeName, compatibleWithVersion, accept);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling A1PolicyManagementApi#getPolicyTypes");
+            e.printStackTrace();
+        }
+    }
+}

+ +


+
+// Create an instance of the API class
+A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
+String *nearRtRicId = nearRtRicId_example; // Select types for the given Near-RT RIC identity. (optional) (default to null)
+String *typeName = typeName_example; // Select types with the given type name (type identity has the format ) (optional) (default to null)
+String *compatibleWithVersion = compatibleWithVersion_example; // Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. (optional) (default to null)
+String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+[apiInstance getPolicyTypesWith:nearRtRicId
+    typeName:typeName
+    compatibleWithVersion:compatibleWithVersion
+    accept:accept
+              completionHandler: ^(array[PolicyTypeInformation] output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+

+ +

var A1PolicyManagementApi = require('a1_policy_management_api');
+
+// Create an instance of the API class
+var api = new A1PolicyManagementApi.A1PolicyManagementApi()
+var opts = {
+  'nearRtRicId': nearRtRicId_example, // {String} Select types for the given Near-RT RIC identity.
+  'typeName': typeName_example, // {String} Select types with the given type name (type identity has the format )
+  'compatibleWithVersion': compatibleWithVersion_example, // {String} Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order.
+  'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getPolicyTypes(opts, callback);
+

+ + +

using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class getPolicyTypesExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new A1PolicyManagementApi();
+            var nearRtRicId = nearRtRicId_example;  // String | Select types for the given Near-RT RIC identity. (optional)  (default to null)
+            var typeName = typeName_example;  // String | Select types with the given type name (type identity has the format ) (optional)  (default to null)
+            var compatibleWithVersion = compatibleWithVersion_example;  // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. (optional)  (default to null)
+            var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)
+
+            try {
+                array[PolicyTypeInformation] result = apiInstance.getPolicyTypes(nearRtRicId, typeName, compatibleWithVersion, accept);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling A1PolicyManagementApi.getPolicyTypes: " + e.Message );
+            }
+        }
+    }
+}
+

+ +

<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\A1PolicyManagementApi();
+$nearRtRicId = nearRtRicId_example; // String | Select types for the given Near-RT RIC identity.
+$typeName = typeName_example; // String | Select types with the given type name (type identity has the format )
+$compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order.
+$accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    $result = $api_instance->getPolicyTypes($nearRtRicId, $typeName, $compatibleWithVersion, $accept);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling A1PolicyManagementApi->getPolicyTypes: ', $e->getMessage(), PHP_EOL;
+}
+?>

+ +

use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::A1PolicyManagementApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::A1PolicyManagementApi->new();
+my $nearRtRicId = nearRtRicId_example; # String | Select types for the given Near-RT RIC identity.
+my $typeName = typeName_example; # String | Select types with the given type name (type identity has the format )
+my $compatibleWithVersion = compatibleWithVersion_example; # String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order.
+my $accept = application/json; # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+eval {
+    my $result = $api_instance->getPolicyTypes(nearRtRicId => $nearRtRicId, typeName => $typeName, compatibleWithVersion => $compatibleWithVersion, accept => $accept);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling A1PolicyManagementApi->getPolicyTypes: $@\n";
+}

+ +

from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.A1PolicyManagementApi()
+nearRtRicId = nearRtRicId_example # String | Select types for the given Near-RT RIC identity. (optional) (default to null)
+typeName = typeName_example # String | Select types with the given type name (type identity has the format ) (optional) (default to null)
+compatibleWithVersion = compatibleWithVersion_example # String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. (optional) (default to null)
+accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+try:
+    api_response = api_instance.get_policy_types(nearRtRicId=nearRtRicId, typeName=typeName, compatibleWithVersion=compatibleWithVersion, accept=accept)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling A1PolicyManagementApi->getPolicyTypes: %s\n" % e)

+ +

extern crate A1PolicyManagementApi;
+
+pub fn main() {
+    let nearRtRicId = nearRtRicId_example; // String
+    let typeName = typeName_example; // String
+    let compatibleWithVersion = compatibleWithVersion_example; // String
+    let accept = application/json; // String
+
+    let mut context = A1PolicyManagementApi::Context::default();
+    let result = client.getPolicyTypes(nearRtRicId, typeName, compatibleWithVersion, accept, &context).wait();
+
+    println!("{:?}", result);
+}
+

+ +

Scopes

+ + +

+ +

Parameters

+ + +

Header parameters

+ + + + + + + + + +

Name	Description
Accept	+ + + + + + + String + + + +Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. + + + + +

+ + + +

Query parameters

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

Name	Description
nearRtRicId	+ + + + + + + String + + + +Select types for the given Near-RT RIC identity. + + + + +
typeName	+ + + + + + + String + + + +Select types with the given type name (type identity has the format <typename_version>) + + + + +
compatibleWithVersion	+ + + + + + + String + + + +Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + + + + +

+ +

Responses

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

putPolicy

update a policy

+
+

/policies/{policyId}

Usage and SDK Samples

+ +

curl -X PUT \
+ -H "Accept: application/json,application/problem+json" \
+ -H "Content-Type: application/json" \
+ "https://example.com/a1-policy-management/v1/policies/{policyId}" \
+ -d ''
+

import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.A1PolicyManagementApi;
+
+import java.io.File;
+import java.util.*;
+
+public class A1PolicyManagementApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
+        String policyId = policyId_example; // String | 
+        Object body = Object; // Object | 
+
+        try {
+            Object result = apiInstance.putPolicy(policyId, body);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling A1PolicyManagementApi#putPolicy");
+            e.printStackTrace();
+        }
+    }
+}
+

+ +

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String policyId = new String(); // String | 
+final Object body = new Object(); // Object | 
+
+try {
+    final result = await api_instance.putPolicy(policyId, body);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->putPolicy: $e\n');
+}
+
+

+ +

import org.openapitools.client.api.A1PolicyManagementApi;
+
+public class A1PolicyManagementApiExample {
+    public static void main(String[] args) {
+        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
+        String policyId = policyId_example; // String | 
+        Object body = Object; // Object | 
+
+        try {
+            Object result = apiInstance.putPolicy(policyId, body);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling A1PolicyManagementApi#putPolicy");
+            e.printStackTrace();
+        }
+    }
+}

+ +


+
+// Create an instance of the API class
+A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
+String *policyId = policyId_example; //  (default to null)
+Object *body = Object; // 
+
+[apiInstance putPolicyWith:policyId
+    body:body
+              completionHandler: ^(Object output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+

+ +

var A1PolicyManagementApi = require('a1_policy_management_api');
+
+// Create an instance of the API class
+var api = new A1PolicyManagementApi.A1PolicyManagementApi()
+var policyId = policyId_example; // {String} 
+var body = Object; // {Object} 
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.putPolicy(policyId, body, callback);
+

+ + +

using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class putPolicyExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new A1PolicyManagementApi();
+            var policyId = policyId_example;  // String |  (default to null)
+            var body = Object;  // Object | 
+
+            try {
+                Object result = apiInstance.putPolicy(policyId, body);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling A1PolicyManagementApi.putPolicy: " + e.Message );
+            }
+        }
+    }
+}
+

+ +

<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\A1PolicyManagementApi();
+$policyId = policyId_example; // String | 
+$body = Object; // Object | 
+
+try {
+    $result = $api_instance->putPolicy($policyId, $body);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling A1PolicyManagementApi->putPolicy: ', $e->getMessage(), PHP_EOL;
+}
+?>

+ +

use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::A1PolicyManagementApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::A1PolicyManagementApi->new();
+my $policyId = policyId_example; # String | 
+my $body = WWW::OPenAPIClient::Object::Object->new(); # Object | 
+
+eval {
+    my $result = $api_instance->putPolicy(policyId => $policyId, body => $body);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling A1PolicyManagementApi->putPolicy: $@\n";
+}

+ +

from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.A1PolicyManagementApi()
+policyId = policyId_example # String |  (default to null)
+body = Object # Object | 
+
+try:
+    api_response = api_instance.put_policy(policyId, body)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling A1PolicyManagementApi->putPolicy: %s\n" % e)

+ +

extern crate A1PolicyManagementApi;
+
+pub fn main() {
+    let policyId = policyId_example; // String
+    let body = Object; // Object
+
+    let mut context = A1PolicyManagementApi::Context::default();
+    let result = client.putPolicy(policyId, body, &context).wait();
+
+    println!("{:?}", result);
+}
+

+ +

Scopes

+ + +

+ +

Parameters

+ +

Path parameters

+ + + + + + + + + +

Name	Description
policyId*	+ + + + + + + String + + + + + Required + + + +

+ + +

Body parameters

+ + + + + + + + + +

Name	Description
body *	+ + + +

+ + + +

Responses

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

Configuration

getConfiguration

Returns the contents of the application configuration

+
+

/configuration

Usage and SDK Samples

+ +

curl -X GET \
+ -H "Accept: application/json,application/problem+json" \
+ "https://example.com/a1-policy-management/v1/configuration"
+

import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.ConfigurationApi;
+
+import java.io.File;
+import java.util.*;
+
+public class ConfigurationApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        ConfigurationApi apiInstance = new ConfigurationApi();
+
+        try {
+            'String' result = apiInstance.getConfiguration();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling ConfigurationApi#getConfiguration");
+            e.printStackTrace();
+        }
+    }
+}
+

+ +

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+
+try {
+    final result = await api_instance.getConfiguration();
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getConfiguration: $e\n');
+}
+
+

+ +

import org.openapitools.client.api.ConfigurationApi;
+
+public class ConfigurationApiExample {
+    public static void main(String[] args) {
+        ConfigurationApi apiInstance = new ConfigurationApi();
+
+        try {
+            'String' result = apiInstance.getConfiguration();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling ConfigurationApi#getConfiguration");
+            e.printStackTrace();
+        }
+    }
+}

+ +


+
+// Create an instance of the API class
+ConfigurationApi *apiInstance = [[ConfigurationApi alloc] init];
+
+[apiInstance getConfigurationWithCompletionHandler: 
+              ^('String' output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+

+ +

var A1PolicyManagementApi = require('a1_policy_management_api');
+
+// Create an instance of the API class
+var api = new A1PolicyManagementApi.ConfigurationApi()
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getConfiguration(callback);
+

+ + +

using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class getConfigurationExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new ConfigurationApi();
+
+            try {
+                'String' result = apiInstance.getConfiguration();
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling ConfigurationApi.getConfiguration: " + e.Message );
+            }
+        }
+    }
+}
+

+ +

<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\ConfigurationApi();
+
+try {
+    $result = $api_instance->getConfiguration();
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling ConfigurationApi->getConfiguration: ', $e->getMessage(), PHP_EOL;
+}
+?>

+ +

use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::ConfigurationApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::ConfigurationApi->new();
+
+eval {
+    my $result = $api_instance->getConfiguration();
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling ConfigurationApi->getConfiguration: $@\n";
+}

+ +

from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.ConfigurationApi()
+
+try:
+    api_response = api_instance.get_configuration()
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling ConfigurationApi->getConfiguration: %s\n" % e)

+ +

extern crate ConfigurationApi;
+
+pub fn main() {
+
+    let mut context = ConfigurationApi::Context::default();
+    let result = client.getConfiguration(&context).wait();
+
+    println!("{:?}", result);
+}
+

+ +

Scopes

+ + +

+ +

Parameters

+ + + + + + +

Responses

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

putConfiguration

Replace the current configuration file with the given configuration

+
+

/configuration

Usage and SDK Samples

+ +

curl -X PUT \
+ -H "Accept: */*,application/problem+json" \
+ -H "Content-Type: application/json" \
+ "https://example.com/a1-policy-management/v1/configuration" \
+ -d ''
+

import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.ConfigurationApi;
+
+import java.io.File;
+import java.util.*;
+
+public class ConfigurationApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        ConfigurationApi apiInstance = new ConfigurationApi();
+        Object body = Object; // Object | 
+
+        try {
+            Object result = apiInstance.putConfiguration(body);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling ConfigurationApi#putConfiguration");
+            e.printStackTrace();
+        }
+    }
+}
+

+ +

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final Object body = new Object(); // Object | 
+
+try {
+    final result = await api_instance.putConfiguration(body);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->putConfiguration: $e\n');
+}
+
+

+ +

import org.openapitools.client.api.ConfigurationApi;
+
+public class ConfigurationApiExample {
+    public static void main(String[] args) {
+        ConfigurationApi apiInstance = new ConfigurationApi();
+        Object body = Object; // Object | 
+
+        try {
+            Object result = apiInstance.putConfiguration(body);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling ConfigurationApi#putConfiguration");
+            e.printStackTrace();
+        }
+    }
+}

+ +


+
+// Create an instance of the API class
+ConfigurationApi *apiInstance = [[ConfigurationApi alloc] init];
+Object *body = Object; // 
+
+[apiInstance putConfigurationWith:body
+              completionHandler: ^(Object output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+

+ +

var A1PolicyManagementApi = require('a1_policy_management_api');
+
+// Create an instance of the API class
+var api = new A1PolicyManagementApi.ConfigurationApi()
+var body = Object; // {Object} 
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.putConfiguration(body, callback);
+

+ + +

using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class putConfigurationExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new ConfigurationApi();
+            var body = Object;  // Object | 
+
+            try {
+                Object result = apiInstance.putConfiguration(body);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling ConfigurationApi.putConfiguration: " + e.Message );
+            }
+        }
+    }
+}
+

+ +

<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\ConfigurationApi();
+$body = Object; // Object | 
+
+try {
+    $result = $api_instance->putConfiguration($body);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling ConfigurationApi->putConfiguration: ', $e->getMessage(), PHP_EOL;
+}
+?>

+ +

use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::ConfigurationApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::ConfigurationApi->new();
+my $body = WWW::OPenAPIClient::Object::Object->new(); # Object | 
+
+eval {
+    my $result = $api_instance->putConfiguration(body => $body);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling ConfigurationApi->putConfiguration: $@\n";
+}

+ +

from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.ConfigurationApi()
+body = Object # Object | 
+
+try:
+    api_response = api_instance.put_configuration(body)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling ConfigurationApi->putConfiguration: %s\n" % e)

+ +

extern crate ConfigurationApi;
+
+pub fn main() {
+    let body = Object; // Object
+
+    let mut context = ConfigurationApi::Context::default();
+    let result = client.putConfiguration(body, &context).wait();
+
+    println!("{:?}", result);
+}
+

+ +

Scopes

+ + +

+ +

Parameters

+ + + +

Body parameters

+ + + + + + + + + +

Name	Description
body *	+ + + +

+ + + +

Responses

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

HealthCheck

getStatus

Returns status and statistics of this service

+
+

/status

Usage and SDK Samples

+ +

curl -X GET \
+ -H "Accept: application/json" \
+ "https://example.com/a1-policy-management/v1/status"
+

import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.HealthCheckApi;
+
+import java.io.File;
+import java.util.*;
+
+public class HealthCheckApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        HealthCheckApi apiInstance = new HealthCheckApi();
+
+        try {
+            StatusInfo result = apiInstance.getStatus();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling HealthCheckApi#getStatus");
+            e.printStackTrace();
+        }
+    }
+}
+

+ +

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+
+try {
+    final result = await api_instance.getStatus();
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getStatus: $e\n');
+}
+
+

+ +

import org.openapitools.client.api.HealthCheckApi;
+
+public class HealthCheckApiExample {
+    public static void main(String[] args) {
+        HealthCheckApi apiInstance = new HealthCheckApi();
+
+        try {
+            StatusInfo result = apiInstance.getStatus();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling HealthCheckApi#getStatus");
+            e.printStackTrace();
+        }
+    }
+}

+ +


+
+// Create an instance of the API class
+HealthCheckApi *apiInstance = [[HealthCheckApi alloc] init];
+
+[apiInstance getStatusWithCompletionHandler: 
+              ^(StatusInfo output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+

+ +

var A1PolicyManagementApi = require('a1_policy_management_api');
+
+// Create an instance of the API class
+var api = new A1PolicyManagementApi.HealthCheckApi()
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getStatus(callback);
+

+ + +

using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class getStatusExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new HealthCheckApi();
+
+            try {
+                StatusInfo result = apiInstance.getStatus();
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling HealthCheckApi.getStatus: " + e.Message );
+            }
+        }
+    }
+}
+

+ +

<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\HealthCheckApi();
+
+try {
+    $result = $api_instance->getStatus();
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling HealthCheckApi->getStatus: ', $e->getMessage(), PHP_EOL;
+}
+?>

+ +

use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::HealthCheckApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::HealthCheckApi->new();
+
+eval {
+    my $result = $api_instance->getStatus();
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling HealthCheckApi->getStatus: $@\n";
+}

+ +

from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.HealthCheckApi()
+
+try:
+    api_response = api_instance.get_status()
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling HealthCheckApi->getStatus: %s\n" % e)

+ +

extern crate HealthCheckApi;
+
+pub fn main() {
+
+    let mut context = HealthCheckApi::Context::default();
+    let result = client.getStatus(&context).wait();
+
+    println!("{:?}", result);
+}
+

+ +

Scopes

+ + +

+ +

Parameters

+ + + + + + +

Responses

+ + + +

+ Schema +

+ + +

+ +

NearRTRICRepository

getRic

Returns info for one Near-RT RIC

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

+
+

/rics/ric

Usage and SDK Samples

+ +

curl -X GET \
+ -H "Accept: application/json,application/problem+json" \
+ "https://example.com/a1-policy-management/v1/rics/ric?managedElementId=managedElementId_example&ricId=ricId_example"
+

import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.NearRTRICRepositoryApi;
+
+import java.io.File;
+import java.util.*;
+
+public class NearRTRICRepositoryApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        NearRTRICRepositoryApi apiInstance = new NearRTRICRepositoryApi();
+        String managedElementId = managedElementId_example; // String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
+        String ricId = ricId_example; // String | The identity of a Near-RT RIC to get information for.
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            RicInfo result = apiInstance.getRic(managedElementId, ricId, accept);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling NearRTRICRepositoryApi#getRic");
+            e.printStackTrace();
+        }
+    }
+}
+

+ +

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String managedElementId = new String(); // String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
+final String ricId = new String(); // String | The identity of a Near-RT RIC to get information for.
+final String accept = new String(); // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    final result = await api_instance.getRic(managedElementId, ricId, accept);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getRic: $e\n');
+}
+
+

+ +

import org.openapitools.client.api.NearRTRICRepositoryApi;
+
+public class NearRTRICRepositoryApiExample {
+    public static void main(String[] args) {
+        NearRTRICRepositoryApi apiInstance = new NearRTRICRepositoryApi();
+        String managedElementId = managedElementId_example; // String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
+        String ricId = ricId_example; // String | The identity of a Near-RT RIC to get information for.
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            RicInfo result = apiInstance.getRic(managedElementId, ricId, accept);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling NearRTRICRepositoryApi#getRic");
+            e.printStackTrace();
+        }
+    }
+}

+ +


+
+// Create an instance of the API class
+NearRTRICRepositoryApi *apiInstance = [[NearRTRICRepositoryApi alloc] init];
+String *managedElementId = managedElementId_example; // The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned. (optional) (default to null)
+String *ricId = ricId_example; // The identity of a Near-RT RIC to get information for. (optional) (default to null)
+String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+// Returns info for one Near-RT RIC
+[apiInstance getRicWith:managedElementId
+    ricId:ricId
+    accept:accept
+              completionHandler: ^(RicInfo output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+

+ +

var A1PolicyManagementApi = require('a1_policy_management_api');
+
+// Create an instance of the API class
+var api = new A1PolicyManagementApi.NearRTRICRepositoryApi()
+var opts = {
+  'managedElementId': managedElementId_example, // {String} The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
+  'ricId': ricId_example, // {String} The identity of a Near-RT RIC to get information for.
+  'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getRic(opts, callback);
+

+ + +

using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class getRicExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new NearRTRICRepositoryApi();
+            var managedElementId = managedElementId_example;  // String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned. (optional)  (default to null)
+            var ricId = ricId_example;  // String | The identity of a Near-RT RIC to get information for. (optional)  (default to null)
+            var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)
+
+            try {
+                // Returns info for one Near-RT RIC
+                RicInfo result = apiInstance.getRic(managedElementId, ricId, accept);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling NearRTRICRepositoryApi.getRic: " + e.Message );
+            }
+        }
+    }
+}
+

+ +

<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\NearRTRICRepositoryApi();
+$managedElementId = managedElementId_example; // String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
+$ricId = ricId_example; // String | The identity of a Near-RT RIC to get information for.
+$accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    $result = $api_instance->getRic($managedElementId, $ricId, $accept);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling NearRTRICRepositoryApi->getRic: ', $e->getMessage(), PHP_EOL;
+}
+?>

+ +

use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::NearRTRICRepositoryApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::NearRTRICRepositoryApi->new();
+my $managedElementId = managedElementId_example; # String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
+my $ricId = ricId_example; # String | The identity of a Near-RT RIC to get information for.
+my $accept = application/json; # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+eval {
+    my $result = $api_instance->getRic(managedElementId => $managedElementId, ricId => $ricId, accept => $accept);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling NearRTRICRepositoryApi->getRic: $@\n";
+}

+ +

from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.NearRTRICRepositoryApi()
+managedElementId = managedElementId_example # String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned. (optional) (default to null)
+ricId = ricId_example # String | The identity of a Near-RT RIC to get information for. (optional) (default to null)
+accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+try:
+    # Returns info for one Near-RT RIC
+    api_response = api_instance.get_ric(managedElementId=managedElementId, ricId=ricId, accept=accept)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling NearRTRICRepositoryApi->getRic: %s\n" % e)

+ +

extern crate NearRTRICRepositoryApi;
+
+pub fn main() {
+    let managedElementId = managedElementId_example; // String
+    let ricId = ricId_example; // String
+    let accept = application/json; // String
+
+    let mut context = NearRTRICRepositoryApi::Context::default();
+    let result = client.getRic(managedElementId, ricId, accept, &context).wait();
+
+    println!("{:?}", result);
+}
+

+ +

Scopes

+ + +

+ +

Parameters

+ + +

Header parameters

+ + + + + + + + + +

Name	Description
Accept	+ + + + + + + String + + + +Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. + + + + +

+ + + +

Query parameters

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

Name	Description
managedElementId	+ + + + + + + String + + + +The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned. + + + + +
ricId	+ + + + + + + String + + + +The identity of a Near-RT RIC to get information for. + + + + +

+ +

Responses

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

getRics

Query Near-RT RIC information

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

+
+

/rics

Usage and SDK Samples

+ +

curl -X GET \
+ -H "Accept: application/json,application/problem+json" \
+ "https://example.com/a1-policy-management/v1/rics?policyTypeId=policyTypeId_example"
+

import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.NearRTRICRepositoryApi;
+
+import java.io.File;
+import java.util.*;
+
+public class NearRTRICRepositoryApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        NearRTRICRepositoryApi apiInstance = new NearRTRICRepositoryApi();
+        String policyTypeId = policyTypeId_example; // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            RicInfoList result = apiInstance.getRics(policyTypeId, accept);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling NearRTRICRepositoryApi#getRics");
+            e.printStackTrace();
+        }
+    }
+}
+

+ +

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String policyTypeId = new String(); // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
+final String accept = new String(); // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    final result = await api_instance.getRics(policyTypeId, accept);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getRics: $e\n');
+}
+
+

+ +

import org.openapitools.client.api.NearRTRICRepositoryApi;
+
+public class NearRTRICRepositoryApiExample {
+    public static void main(String[] args) {
+        NearRTRICRepositoryApi apiInstance = new NearRTRICRepositoryApi();
+        String policyTypeId = policyTypeId_example; // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            RicInfoList result = apiInstance.getRics(policyTypeId, accept);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling NearRTRICRepositoryApi#getRics");
+            e.printStackTrace();
+        }
+    }
+}

+ +


+
+// Create an instance of the API class
+NearRTRICRepositoryApi *apiInstance = [[NearRTRICRepositoryApi alloc] init];
+String *policyTypeId = policyTypeId_example; // The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned (optional) (default to null)
+String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+// Query Near-RT RIC information
+[apiInstance getRicsWith:policyTypeId
+    accept:accept
+              completionHandler: ^(RicInfoList output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+

+ +

var A1PolicyManagementApi = require('a1_policy_management_api');
+
+// Create an instance of the API class
+var api = new A1PolicyManagementApi.NearRTRICRepositoryApi()
+var opts = {
+  'policyTypeId': policyTypeId_example, // {String} The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
+  'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getRics(opts, callback);
+

+ + +

using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class getRicsExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new NearRTRICRepositoryApi();
+            var policyTypeId = policyTypeId_example;  // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned (optional)  (default to null)
+            var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)
+
+            try {
+                // Query Near-RT RIC information
+                RicInfoList result = apiInstance.getRics(policyTypeId, accept);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling NearRTRICRepositoryApi.getRics: " + e.Message );
+            }
+        }
+    }
+}
+

+ +

<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\NearRTRICRepositoryApi();
+$policyTypeId = policyTypeId_example; // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
+$accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    $result = $api_instance->getRics($policyTypeId, $accept);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling NearRTRICRepositoryApi->getRics: ', $e->getMessage(), PHP_EOL;
+}
+?>

+ +

use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::NearRTRICRepositoryApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::NearRTRICRepositoryApi->new();
+my $policyTypeId = policyTypeId_example; # String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
+my $accept = application/json; # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+eval {
+    my $result = $api_instance->getRics(policyTypeId => $policyTypeId, accept => $accept);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling NearRTRICRepositoryApi->getRics: $@\n";
+}

+ +

from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.NearRTRICRepositoryApi()
+policyTypeId = policyTypeId_example # String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned (optional) (default to null)
+accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+try:
+    # Query Near-RT RIC information
+    api_response = api_instance.get_rics(policyTypeId=policyTypeId, accept=accept)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling NearRTRICRepositoryApi->getRics: %s\n" % e)

+ +

extern crate NearRTRICRepositoryApi;
+
+pub fn main() {
+    let policyTypeId = policyTypeId_example; // String
+    let accept = application/json; // String
+
+    let mut context = NearRTRICRepositoryApi::Context::default();
+    let result = client.getRics(policyTypeId, accept, &context).wait();
+
+    println!("{:?}", result);
+}
+

+ +

Scopes

+ + +

+ +

Parameters

+ + +

Header parameters

+ + + + + + + + + +

Name	Description
Accept	+ + + + + + + String + + + +Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. + + + + +

+ + + +

Query parameters

+ + + + + + + + + +

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

+ +

Responses

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

ServiceRegistryAndSupervision

deleteService

Unregister a service

+
+

/services/{serviceId}

Usage and SDK Samples

+ +

curl -X DELETE \
+ -H "Accept: */*,application/problem+json" \
+ "https://example.com/a1-policy-management/v1/services/{serviceId}"
+

import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.ServiceRegistryAndSupervisionApi;
+
+import java.io.File;
+import java.util.*;
+
+public class ServiceRegistryAndSupervisionApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        ServiceRegistryAndSupervisionApi apiInstance = new ServiceRegistryAndSupervisionApi();
+        String serviceId = serviceId_example; // String | 
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            Object result = apiInstance.deleteService(serviceId, accept);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling ServiceRegistryAndSupervisionApi#deleteService");
+            e.printStackTrace();
+        }
+    }
+}
+

+ +

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String serviceId = new String(); // String | 
+final String accept = new String(); // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    final result = await api_instance.deleteService(serviceId, accept);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->deleteService: $e\n');
+}
+
+

+ +

import org.openapitools.client.api.ServiceRegistryAndSupervisionApi;
+
+public class ServiceRegistryAndSupervisionApiExample {
+    public static void main(String[] args) {
+        ServiceRegistryAndSupervisionApi apiInstance = new ServiceRegistryAndSupervisionApi();
+        String serviceId = serviceId_example; // String | 
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            Object result = apiInstance.deleteService(serviceId, accept);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling ServiceRegistryAndSupervisionApi#deleteService");
+            e.printStackTrace();
+        }
+    }
+}

+ +


+
+// Create an instance of the API class
+ServiceRegistryAndSupervisionApi *apiInstance = [[ServiceRegistryAndSupervisionApi alloc] init];
+String *serviceId = serviceId_example; //  (default to null)
+String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+[apiInstance deleteServiceWith:serviceId
+    accept:accept
+              completionHandler: ^(Object output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+

+ +

var A1PolicyManagementApi = require('a1_policy_management_api');
+
+// Create an instance of the API class
+var api = new A1PolicyManagementApi.ServiceRegistryAndSupervisionApi()
+var serviceId = serviceId_example; // {String} 
+var opts = {
+  'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.deleteService(serviceId, opts, callback);
+

+ + +

using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class deleteServiceExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new ServiceRegistryAndSupervisionApi();
+            var serviceId = serviceId_example;  // String |  (default to null)
+            var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)
+
+            try {
+                Object result = apiInstance.deleteService(serviceId, accept);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling ServiceRegistryAndSupervisionApi.deleteService: " + e.Message );
+            }
+        }
+    }
+}
+

+ +

<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\ServiceRegistryAndSupervisionApi();
+$serviceId = serviceId_example; // String | 
+$accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    $result = $api_instance->deleteService($serviceId, $accept);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling ServiceRegistryAndSupervisionApi->deleteService: ', $e->getMessage(), PHP_EOL;
+}
+?>

+ +

use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::ServiceRegistryAndSupervisionApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::ServiceRegistryAndSupervisionApi->new();
+my $serviceId = serviceId_example; # String | 
+my $accept = application/json; # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+eval {
+    my $result = $api_instance->deleteService(serviceId => $serviceId, accept => $accept);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling ServiceRegistryAndSupervisionApi->deleteService: $@\n";
+}

+ +

from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.ServiceRegistryAndSupervisionApi()
+serviceId = serviceId_example # String |  (default to null)
+accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+try:
+    api_response = api_instance.delete_service(serviceId, accept=accept)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling ServiceRegistryAndSupervisionApi->deleteService: %s\n" % e)

+ +

extern crate ServiceRegistryAndSupervisionApi;
+
+pub fn main() {
+    let serviceId = serviceId_example; // String
+    let accept = application/json; // String
+
+    let mut context = ServiceRegistryAndSupervisionApi::Context::default();
+    let result = client.deleteService(serviceId, accept, &context).wait();
+
+    println!("{:?}", result);
+}
+

+ +

Scopes

+ + +

+ +

Parameters

+ +

Path parameters

+ + + + + + + + + +

Name	Description
serviceId*	+ + + + + + + String + + + + + Required + + + +

+ +

Header parameters

+ + + + + + + + + +

Name	Description
Accept	+ + + + + + + String + + + +Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. + + + + +

+ + + + +

Responses

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

getServices

Returns service information

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

+
+

/services

Usage and SDK Samples

+ +

curl -X GET \
+ -H "Accept: application/json,application/problem+json" \
+ "https://example.com/a1-policy-management/v1/services?serviceId=serviceId_example"
+

import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.ServiceRegistryAndSupervisionApi;
+
+import java.io.File;
+import java.util.*;
+
+public class ServiceRegistryAndSupervisionApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        ServiceRegistryAndSupervisionApi apiInstance = new ServiceRegistryAndSupervisionApi();
+        String serviceId = serviceId_example; // String | The identity of the service
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            ServiceStatusList result = apiInstance.getServices(serviceId, accept);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling ServiceRegistryAndSupervisionApi#getServices");
+            e.printStackTrace();
+        }
+    }
+}
+

+ +

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String serviceId = new String(); // String | The identity of the service
+final String accept = new String(); // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    final result = await api_instance.getServices(serviceId, accept);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getServices: $e\n');
+}
+
+

+ +

import org.openapitools.client.api.ServiceRegistryAndSupervisionApi;
+
+public class ServiceRegistryAndSupervisionApiExample {
+    public static void main(String[] args) {
+        ServiceRegistryAndSupervisionApi apiInstance = new ServiceRegistryAndSupervisionApi();
+        String serviceId = serviceId_example; // String | The identity of the service
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            ServiceStatusList result = apiInstance.getServices(serviceId, accept);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling ServiceRegistryAndSupervisionApi#getServices");
+            e.printStackTrace();
+        }
+    }
+}

+ +


+
+// Create an instance of the API class
+ServiceRegistryAndSupervisionApi *apiInstance = [[ServiceRegistryAndSupervisionApi alloc] init];
+String *serviceId = serviceId_example; // The identity of the service (optional) (default to null)
+String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+// Returns service information
+[apiInstance getServicesWith:serviceId
+    accept:accept
+              completionHandler: ^(ServiceStatusList output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+

+ +

var A1PolicyManagementApi = require('a1_policy_management_api');
+
+// Create an instance of the API class
+var api = new A1PolicyManagementApi.ServiceRegistryAndSupervisionApi()
+var opts = {
+  'serviceId': serviceId_example, // {String} The identity of the service
+  'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getServices(opts, callback);
+

+ + +

using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class getServicesExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new ServiceRegistryAndSupervisionApi();
+            var serviceId = serviceId_example;  // String | The identity of the service (optional)  (default to null)
+            var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)
+
+            try {
+                // Returns service information
+                ServiceStatusList result = apiInstance.getServices(serviceId, accept);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling ServiceRegistryAndSupervisionApi.getServices: " + e.Message );
+            }
+        }
+    }
+}
+

+ +

<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\ServiceRegistryAndSupervisionApi();
+$serviceId = serviceId_example; // String | The identity of the service
+$accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    $result = $api_instance->getServices($serviceId, $accept);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling ServiceRegistryAndSupervisionApi->getServices: ', $e->getMessage(), PHP_EOL;
+}
+?>

+ +

use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::ServiceRegistryAndSupervisionApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::ServiceRegistryAndSupervisionApi->new();
+my $serviceId = serviceId_example; # String | The identity of the service
+my $accept = application/json; # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+eval {
+    my $result = $api_instance->getServices(serviceId => $serviceId, accept => $accept);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling ServiceRegistryAndSupervisionApi->getServices: $@\n";
+}

+ +

from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.ServiceRegistryAndSupervisionApi()
+serviceId = serviceId_example # String | The identity of the service (optional) (default to null)
+accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+try:
+    # Returns service information
+    api_response = api_instance.get_services(serviceId=serviceId, accept=accept)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling ServiceRegistryAndSupervisionApi->getServices: %s\n" % e)

+ +

extern crate ServiceRegistryAndSupervisionApi;
+
+pub fn main() {
+    let serviceId = serviceId_example; // String
+    let accept = application/json; // String
+
+    let mut context = ServiceRegistryAndSupervisionApi::Context::default();
+    let result = client.getServices(serviceId, accept, &context).wait();
+
+    println!("{:?}", result);
+}
+

+ +

Scopes

+ + +

+ +

Parameters

+ + +

Header parameters

+ + + + + + + + + +

Name	Description
Accept	+ + + + + + + String + + + +Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. + + + + +

+ + + +

Query parameters

+ + + + + + + + + +

Name	Description
serviceId	+ + + + + + + String + + + +The identity of the service + + + + +

+ +

Responses

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

keepAliveService

Heartbeat indicates that the service is running

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

+
+

/services/{serviceId}/keepalive

Usage and SDK Samples

+ +

curl -X PUT \
+ -H "Accept: */*,application/problem+json" \
+ -H "Content-Type: application/json" \
+ "https://example.com/a1-policy-management/v1/services/{serviceId}/keepalive" \
+ -d ''
+

import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.ServiceRegistryAndSupervisionApi;
+
+import java.io.File;
+import java.util.*;
+
+public class ServiceRegistryAndSupervisionApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        ServiceRegistryAndSupervisionApi apiInstance = new ServiceRegistryAndSupervisionApi();
+        String serviceId = serviceId_example; // String | 
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+        String body = body_example; // String | 
+
+        try {
+            Object result = apiInstance.keepAliveService(serviceId, accept, body);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling ServiceRegistryAndSupervisionApi#keepAliveService");
+            e.printStackTrace();
+        }
+    }
+}
+

+ +

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String serviceId = new String(); // String | 
+final String accept = new String(); // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+final String body = new String(); // String | 
+
+try {
+    final result = await api_instance.keepAliveService(serviceId, accept, body);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->keepAliveService: $e\n');
+}
+
+

+ +

import org.openapitools.client.api.ServiceRegistryAndSupervisionApi;
+
+public class ServiceRegistryAndSupervisionApiExample {
+    public static void main(String[] args) {
+        ServiceRegistryAndSupervisionApi apiInstance = new ServiceRegistryAndSupervisionApi();
+        String serviceId = serviceId_example; // String | 
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+        String body = body_example; // String | 
+
+        try {
+            Object result = apiInstance.keepAliveService(serviceId, accept, body);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling ServiceRegistryAndSupervisionApi#keepAliveService");
+            e.printStackTrace();
+        }
+    }
+}

+ +


+
+// Create an instance of the API class
+ServiceRegistryAndSupervisionApi *apiInstance = [[ServiceRegistryAndSupervisionApi alloc] init];
+String *serviceId = serviceId_example; //  (default to null)
+String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+String *body = body_example; //  (optional)
+
+// Heartbeat indicates that the service is running
+[apiInstance keepAliveServiceWith:serviceId
+    accept:accept
+    body:body
+              completionHandler: ^(Object output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+

+ +

var A1PolicyManagementApi = require('a1_policy_management_api');
+
+// Create an instance of the API class
+var api = new A1PolicyManagementApi.ServiceRegistryAndSupervisionApi()
+var serviceId = serviceId_example; // {String} 
+var opts = {
+  'accept': application/json, // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+  'body': body_example // {String} 
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.keepAliveService(serviceId, opts, callback);
+

+ + +

using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class keepAliveServiceExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new ServiceRegistryAndSupervisionApi();
+            var serviceId = serviceId_example;  // String |  (default to null)
+            var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)
+            var body = body_example;  // String |  (optional) 
+
+            try {
+                // Heartbeat indicates that the service is running
+                Object result = apiInstance.keepAliveService(serviceId, accept, body);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling ServiceRegistryAndSupervisionApi.keepAliveService: " + e.Message );
+            }
+        }
+    }
+}
+

+ +

<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\ServiceRegistryAndSupervisionApi();
+$serviceId = serviceId_example; // String | 
+$accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+$body = body_example; // String | 
+
+try {
+    $result = $api_instance->keepAliveService($serviceId, $accept, $body);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling ServiceRegistryAndSupervisionApi->keepAliveService: ', $e->getMessage(), PHP_EOL;
+}
+?>

+ +

use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::ServiceRegistryAndSupervisionApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::ServiceRegistryAndSupervisionApi->new();
+my $serviceId = serviceId_example; # String | 
+my $accept = application/json; # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+my $body = WWW::OPenAPIClient::Object::String->new(); # String | 
+
+eval {
+    my $result = $api_instance->keepAliveService(serviceId => $serviceId, accept => $accept, body => $body);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling ServiceRegistryAndSupervisionApi->keepAliveService: $@\n";
+}

+ +

from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.ServiceRegistryAndSupervisionApi()
+serviceId = serviceId_example # String |  (default to null)
+accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+body = body_example # String |  (optional)
+
+try:
+    # Heartbeat indicates that the service is running
+    api_response = api_instance.keep_alive_service(serviceId, accept=accept, body=body)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling ServiceRegistryAndSupervisionApi->keepAliveService: %s\n" % e)

+ +

extern crate ServiceRegistryAndSupervisionApi;
+
+pub fn main() {
+    let serviceId = serviceId_example; // String
+    let accept = application/json; // String
+    let body = body_example; // String
+
+    let mut context = ServiceRegistryAndSupervisionApi::Context::default();
+    let result = client.keepAliveService(serviceId, accept, body, &context).wait();
+
+    println!("{:?}", result);
+}
+

+ +

Scopes

+ + +

+ +

Parameters

+ +

Path parameters

+ + + + + + + + + +

Name	Description
serviceId*	+ + + + + + + String + + + + + Required + + + +

+ +

Header parameters

+ + + + + + + + + +

Name	Description
Accept	+ + + + + + + String + + + +Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. + + + + +

+ +

Body parameters

+ + + + + + + + + +

Name	Description
body	+ + + +

+ + + +

Responses

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

putService

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

+
+

/services

Usage and SDK Samples

+ +

curl -X PUT \
+ -H "Accept: */*,application/problem+json" \
+ -H "Content-Type: application/json" \
+ "https://example.com/a1-policy-management/v1/services" \
+ -d '{
+  "keepAliveIntervalSeconds" : 0,
+  "callbackUrl" : "callbackUrl",
+  "serviceId" : "serviceId"
+}'
+

import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.ServiceRegistryAndSupervisionApi;
+
+import java.io.File;
+import java.util.*;
+
+public class ServiceRegistryAndSupervisionApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        ServiceRegistryAndSupervisionApi apiInstance = new ServiceRegistryAndSupervisionApi();
+        ServiceRegistrationInfo serviceRegistrationInfo = ; // ServiceRegistrationInfo | 
+
+        try {
+            Object result = apiInstance.putService(serviceRegistrationInfo);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling ServiceRegistryAndSupervisionApi#putService");
+            e.printStackTrace();
+        }
+    }
+}
+

+ +

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final ServiceRegistrationInfo serviceRegistrationInfo = new ServiceRegistrationInfo(); // ServiceRegistrationInfo | 
+
+try {
+    final result = await api_instance.putService(serviceRegistrationInfo);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->putService: $e\n');
+}
+
+

+ +

import org.openapitools.client.api.ServiceRegistryAndSupervisionApi;
+
+public class ServiceRegistryAndSupervisionApiExample {
+    public static void main(String[] args) {
+        ServiceRegistryAndSupervisionApi apiInstance = new ServiceRegistryAndSupervisionApi();
+        ServiceRegistrationInfo serviceRegistrationInfo = ; // ServiceRegistrationInfo | 
+
+        try {
+            Object result = apiInstance.putService(serviceRegistrationInfo);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling ServiceRegistryAndSupervisionApi#putService");
+            e.printStackTrace();
+        }
+    }
+}

+ +


+
+// Create an instance of the API class
+ServiceRegistryAndSupervisionApi *apiInstance = [[ServiceRegistryAndSupervisionApi alloc] init];
+ServiceRegistrationInfo *serviceRegistrationInfo = ; // 
+
+// Register a service
+[apiInstance putServiceWith:serviceRegistrationInfo
+              completionHandler: ^(Object output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+

+ +

var A1PolicyManagementApi = require('a1_policy_management_api');
+
+// Create an instance of the API class
+var api = new A1PolicyManagementApi.ServiceRegistryAndSupervisionApi()
+var serviceRegistrationInfo = ; // {ServiceRegistrationInfo} 
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.putService(serviceRegistrationInfo, callback);
+

+ + +

using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class putServiceExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new ServiceRegistryAndSupervisionApi();
+            var serviceRegistrationInfo = new ServiceRegistrationInfo(); // ServiceRegistrationInfo | 
+
+            try {
+                // Register a service
+                Object result = apiInstance.putService(serviceRegistrationInfo);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling ServiceRegistryAndSupervisionApi.putService: " + e.Message );
+            }
+        }
+    }
+}
+

+ +

<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\ServiceRegistryAndSupervisionApi();
+$serviceRegistrationInfo = ; // ServiceRegistrationInfo | 
+
+try {
+    $result = $api_instance->putService($serviceRegistrationInfo);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling ServiceRegistryAndSupervisionApi->putService: ', $e->getMessage(), PHP_EOL;
+}
+?>

+ +

use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::ServiceRegistryAndSupervisionApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::ServiceRegistryAndSupervisionApi->new();
+my $serviceRegistrationInfo = WWW::OPenAPIClient::Object::ServiceRegistrationInfo->new(); # ServiceRegistrationInfo | 
+
+eval {
+    my $result = $api_instance->putService(serviceRegistrationInfo => $serviceRegistrationInfo);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling ServiceRegistryAndSupervisionApi->putService: $@\n";
+}

+ +

from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.ServiceRegistryAndSupervisionApi()
+serviceRegistrationInfo =  # ServiceRegistrationInfo | 
+
+try:
+    # Register a service
+    api_response = api_instance.put_service(serviceRegistrationInfo)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling ServiceRegistryAndSupervisionApi->putService: %s\n" % e)

+ +

extern crate ServiceRegistryAndSupervisionApi;
+
+pub fn main() {
+    let serviceRegistrationInfo = ; // ServiceRegistrationInfo
+
+    let mut context = ServiceRegistryAndSupervisionApi::Context::default();
+    let result = client.putService(serviceRegistrationInfo, &context).wait();
+
+    println!("{:?}", result);
+}
+

+ +

Scopes

+ + +

+ +

Parameters

+ + + +

Body parameters

+ + + + + + + + + +

Name	Description
serviceRegistrationInfo *	+ + + +

+ + + +

Responses

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

General

The O-RAN Non-RT RIC Policy Management Service provides a REST API for managemecnt of A1 policies.
The main tasks of the service are:

A1 Policy creation, modification and deletion.
Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs
Maintaining a view of supported Near-RT RIC policy types
Supervision of using services (R-APPs). When a service is unavailable, its policies are removed.

APIs provided or defined by the service

A1 Policy Management

This is an API for management of A1 Policies.

A1 Policy retrieval, creation, modification and deletion.
Retrieval of supported A1 Policy types for a Near-RT RIC
Retrieval of status for existing A1 policies

Management of configuration

API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.

Service callbacks

These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.

NearRT-RIC Repository

This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted for one Near-RT RIC.

Health Check

API used for supervision of the PMS component.

Service Registry and Supervision

Authorization API

API used for access control of A1 Policy access. If configured, an external authorization provider is requested to grant access to the A1 Policy type.

)", + "explode" : true, + "in" : "query", + "name" : "typeName", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + }, { + "description" : "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.", + "explode" : true, + "in" : "query", + "name" : "compatibleWithVersion", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + }, { + "description" : "Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.", + "explode" : false, + "in" : "header", + "name" : "Accept", + "required" : false, + "schema" : { + "example" : "application/json", + "type" : "string" + }, + "style" : "simple" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "items" : { + "$ref" : "#/components/schemas/PolicyTypeInformation" + }, + "type" : "array" + } + } + }, + "description" : "OK - Policy Type IDs found Ok" + }, + "400" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Bad Request" + }, + "401" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Unauthorized" + }, + "403" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Forbidden" + }, + "404" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Not Found" + }, + "406" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Not Acceptable" + }, + "429" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Too Many Request" + }, + "500" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Internal Server Error" + }, + "502" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Bad Gateway" + }, + "503" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Service Unavailable" + } + }, + "tags" : [ "A1 Policy Management" ] + } + }, + "/policy-types/{policyTypeId}" : { + "get" : { + "description" : "Returns a policy type definition", + "operationId" : "getPolicyTypeDefinition", + "parameters" : [ { + "explode" : false, + "in" : "path", + "name" : "policyTypeId", + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.", + "explode" : false, + "in" : "header", + "name" : "Accept", + "required" : false, + "schema" : { + "example" : "application/json", + "type" : "string" + }, + "style" : "simple" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "policyObject" : { + "$ref" : "#/components/examples/PolicyObject" + } + }, + "schema" : { + "$ref" : "#/components/schemas/PolicyObject" + } + } + }, + "description" : "OK - schema of the given policy type" + }, + "400" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Bad Request" + }, + "401" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Unauthorized" + }, + "403" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Forbidden" + }, + "404" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Not Found" + }, + "406" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Not Acceptable" + }, + "429" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Too Many Request" + }, + "500" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Internal Server Error" + }, + "502" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Bad Gateway" + }, + "503" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Service Unavailable" + } + }, + "tags" : [ "A1 Policy Management" ] + } + }, + "/policies/{policyId}" : { + "delete" : { + "description" : "Deleting the policy using policyId.", + "operationId" : "deletePolicy", + "parameters" : [ { + "explode" : false, + "in" : "path", + "name" : "policyId", + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.", + "explode" : false, + "in" : "header", + "name" : "Accept", + "required" : false, + "schema" : { + "example" : "application/json", + "type" : "string" + }, + "style" : "simple" + } ], + "responses" : { + "204" : { + "description" : "The created A1 policy was deleted" + }, + "400" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Bad Request" + }, + "401" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Unauthorized" + }, + "403" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Forbidden" + }, + "404" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Not Found" + }, + "423" : { + "content" : { + "application/problem+json" : { + "example" : { + "status" : 423, + "title" : "Locked", + "detail" : "State is Locked in the provided request." + }, + "schema" : { + "$ref" : "#/components/schemas/ErrorInformation" + } + } + }, + "description" : "Locked - HTTP Status code which can be used when the state is Locked" + }, + "429" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Too Many Request" + }, + "500" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Internal Server Error" + }, + "502" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Bad Gateway" + }, + "503" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Service Unavailable" + } + }, + "summary" : "Delete a policy", + "tags" : [ "A1 Policy Management" ] + }, + "get" : { + "description" : "Returns a policy", + "operationId" : "getPolicy", + "parameters" : [ { + "explode" : false, + "in" : "path", + "name" : "policyId", + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.", + "explode" : false, + "in" : "header", + "name" : "Accept", + "required" : false, + "schema" : { + "example" : "application/json", + "type" : "string" + }, + "style" : "simple" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "policyObject" : { + "$ref" : "#/components/examples/PolicyObject" + } + }, + "schema" : { + "$ref" : "#/components/schemas/PolicyObject" + } + } + }, + "description" : "OK - Policy found" + }, + "400" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Bad Request" + }, + "401" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Unauthorized" + }, + "403" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Forbidden" + }, + "404" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Not Found" + }, + "406" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Not Acceptable" + }, + "429" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Too Many Request" + }, + "500" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Internal Server Error" + }, + "502" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Bad Gateway" + }, + "503" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Service Unavailable" + } + }, + "tags" : [ "A1 Policy Management" ] + }, + "put" : { + "description" : "update a policy", + "operationId" : "putPolicy", + "parameters" : [ { + "explode" : false, + "in" : "path", + "name" : "policyId", + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "examples" : { + "policyObject" : { + "$ref" : "#/components/examples/PolicyObject" + } + }, + "schema" : { + "$ref" : "#/components/schemas/PolicyObject" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PolicyObject" + } + } + }, + "description" : "OK - Policy updated" + }, + "400" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Bad Request" + }, + "401" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Unauthorized" + }, + "403" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Forbidden" + }, + "404" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Not Found" + }, + "406" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Not Acceptable" + }, + "411" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Length Required" + }, + "413" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Payload Too Large" + }, + "415" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Unsupported Media Type" + }, + "423" : { + "content" : { + "application/problem+json" : { + "example" : { + "status" : 423, + "title" : "Locked", + "detail" : "State is Locked in the provided request." + }, + "schema" : { + "$ref" : "#/components/schemas/ErrorInformation" + } + } + }, + "description" : "Locked - HTTP Status code which can be used when the state is Locked" + }, + "429" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Too Many Request" + }, + "500" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Internal Server Error" + }, + "502" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Bad Gateway" + }, + "503" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Service Unavailable" + } + }, + "tags" : [ "A1 Policy Management" ] + } + }, + "/policies" : { + "get" : { + "description" : "Returns a list of A1 policies matching given search criteria.
If several query parameters are defined, the policies matching all conditions are returned.", + "operationId" : "getAllPolicies", + "parameters" : [ { + "description" : "Select policies of a given policy type identity.", + "explode" : true, + "in" : "query", + "name" : "policyTypeId", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + }, { + "description" : "Select policies of a given Near-RT RIC identity.", + "explode" : true, + "in" : "query", + "name" : "nearRtRicId", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + }, { + "description" : "Select policies owned by a given service.", + "explode" : true, + "in" : "query", + "name" : "serviceId", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + }, { + "description" : "Select policies of types with the given type name (type identity has the format )", + "explode" : true, + "in" : "query", + "name" : "typeName", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + }, { + "description" : "Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.", + "explode" : false, + "in" : "header", + "name" : "Accept", + "required" : false, + "schema" : { + "example" : "application/json", + "type" : "string" + }, + "style" : "simple" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "items" : { + "$ref" : "#/components/schemas/PolicyInformation" + }, + "type" : "array" + } + } + }, + "description" : "OK - Policy identities" + }, + "400" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Bad Request" + }, + "401" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Unauthorized" + }, + "403" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Forbidden" + }, + "404" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Not Found" + }, + "406" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Not Acceptable" + }, + "429" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Too Many Request" + }, + "500" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Internal Server Error" + }, + "502" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Bad Gateway" + }, + "503" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Service Unavailable" + } + }, + "summary" : "Query policy identities", + "tags" : [ "A1 Policy Management" ] + }, + "post" : { + "description" : "To create A1 policies", + "operationId" : "createPolicy", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PolicyObjectInformation" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PolicyObjectInformation" + } + } + }, + "description" : "Success case 201 created", + "headers" : { + "Location" : { + "description" : "Contains the URI of the newly created resource", + "explode" : false, + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } + } + }, + "400" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Bad Request" + }, + "401" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Unauthorized" + }, + "403" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Forbidden" + }, + "404" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Not Found" + }, + "406" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Not Acceptable" + }, + "423" : { + "content" : { + "application/problem+json" : { + "example" : { + "status" : 423, + "title" : "Locked", + "detail" : "State is Locked in the provided request." + }, + "schema" : { + "$ref" : "#/components/schemas/ErrorInformation" + } + } + }, + "description" : "Locked - HTTP Status code which can be used when the state is Locked" + }, + "429" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Too Many Request" + }, + "500" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Internal Server Error" + }, + "502" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Bad Gateway" + }, + "503" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Service Unavailable" + } + }, + "tags" : [ "A1 Policy Management" ] + } + }, + "/configuration" : { + "get" : { + "description" : "Returns the contents of the application configuration", + "operationId" : "getConfiguration", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "OK - Application configuration received" + }, + "404" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Not Found" + } + }, + "tags" : [ "Configuration" ] + }, + "put" : { + "description" : "Replace the current configuration file with the given configuration", + "operationId" : "putConfiguration", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "object" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/void" + } + } + }, + "description" : "OK - Configuration updated" + }, + "400" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Bad Request" + } + }, + "tags" : [ "Configuration" ] + } + }, + "/services/{serviceId}/keepalive" : { + "put" : { + "description" : "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)", + "operationId" : "keepAliveService", + "parameters" : [ { + "explode" : false, + "in" : "path", + "name" : "serviceId", + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + }, { + "description" : "Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.", + "explode" : false, + "in" : "header", + "name" : "Accept", + "required" : false, + "schema" : { + "example" : "application/json", + "type" : "string" + }, + "style" : "simple" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "required" : false + }, + "responses" : { + "200" : { + "content" : { + "*/*" : { + "schema" : { + "type" : "object" + } + } + }, + "description" : "OK - Service supervision timer refreshed, OK" + }, + "404" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Not Found" + } + }, + "summary" : "Heartbeat indicates that the service is running", + "tags" : [ "Service Registry and Supervision" ] + } + }, + "/services" : { + "get" : { + "description" : "Either information about a registered service with given identity or all registered services are returned.", + "operationId" : "getServices", + "parameters" : [ { + "description" : "The identity of the service", + "explode" : true, + "in" : "query", + "name" : "serviceId", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + }, { + "description" : "Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.", + "explode" : false, + "in" : "header", + "name" : "Accept", + "required" : false, + "schema" : { + "example" : "application/json", + "type" : "string" + }, + "style" : "simple" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "service_status_list" : { + "$ref" : "#/components/examples/ServiceStatusList" + } + }, + "schema" : { + "$ref" : "#/components/schemas/ServiceStatusList" + } + } + }, + "description" : "OK" + }, + "404" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Not Found" + } + }, + "summary" : "Returns service information", + "tags" : [ "Service Registry and Supervision" ] + }, + "put" : { + "callbacks" : { + "RICStatus" : { + "{$request.body#/callback_url}" : { + "post" : { + "description" : "The URL to this call is registered at Service registration.", + "operationId" : "serviceCallback", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceCallbackInfo" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/void" + } + } + }, + "description" : "OK" + }, + "404" : { + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProblemDetails" + } + } + }, + "description" : "Not Found" + } + }, + "summary" : "Callback for Near-RT RIC status", + "tags" : [ "Service callbacks" ] + } + } + } + }, + "description" : "Registering a service is needed to:

Get callbacks about available NearRT RICs.
Activate supervision of the service. If a service is inactive, its policies will automatically be deleted.

General

The O-RAN Non-RT RIC Policy Management Service provides a REST API for managemecnt of A1 policies.
The main tasks of the service are:

A1 Policy creation, modification and deletion.
Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs
Maintaining a view of supported Near-RT RIC policy types
Supervision of using services (R-APPs). When a service is unavailable, its policies are removed.

APIs provided or defined by the service

A1 Policy Management

This is an API for management of A1 Policies.

A1 Policy retrieval, creation, modification and deletion.
Retrieval of supported A1 Policy types for a Near-RT RIC
Retrieval of status for existing A1 policies

Management of configuration

API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.

Service callbacks

These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.

NearRT-RIC Repository

This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted for one Near-RT RIC.

Health Check

API used for supervision of the PMS component.

Service Registry and Supervision

Authorization API

API used for access control of A1 Policy access. If configured, an external authorization provider is requested to grant access to the A1 Policy type.

Spring Boot Actuator

Provides generic functions used to monitor and manage the Spring web application.

", + "license" : { + "name" : "Copyright (C) 2020-2023 Nordix Foundation. Licensed under the Apache License.", + "url" : "http://www.apache.org/licenses/LICENSE-2.0" + }, + "title" : "A1 Policy Management Service", + "version" : "1.3.0", + "x-api-id" : "a31c510b-20e6-4a08-af16-368c44d7fba8", + "x-audience" : "external-public" + }, + "servers" : [ { + "url" : "/" + } ], + "tags" : [ { + "description" : "API used to create polices, Policy Instances and get them as individual using an ID or get all policies/Instances.", + "name" : "A1 Policy Management" + }, { + "description" : "API used to get the NearRT-RIC for the managed element.", + "name" : "NearRT-RIC Repository" + }, { + "description" : "API used to keep the service Alive with in the timeout period", + "name" : "Service Registry and Supervision" + }, { + "description" : "API used to get the health status and statistics of this service", + "name" : "Health Check" + }, { + "name" : "Service callbacks" + }, { + "description" : "API used for authorization of information A1 policy access (this is provided by an authorization producer such as OPA).
Note that this API is called by PMS, it is not provided.", + "name" : "Authorization API" + }, { + "description" : "API used to create or fetch the application configuration.", + "name" : "Configuration" + }, { + "description" : "Monitor and interact", + "externalDocs" : { + "description" : "Spring Boot Actuator Web API Documentation", + "url" : "https://docs.spring.io/spring-boot/docs/current/actuator-api/html/" + }, + "name" : "Actuator" + } ], + "paths" : { + "/a1-policy/v2/policy-instances" : { + "get" : { + "description" : "Returns a list of A1 policies matching given search criteria.
If several query parameters are defined, the policies matching all conditions are returned.", + "operationId" : "getPolicyInstances", + "parameters" : [ { + "description" : "Select policies with a given type identity.", + "explode" : true, + "in" : "query", + "name" : "policytype_id", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + }, { + "description" : "Select policies for a given Near-RT RIC identity.", + "explode" : true, + "in" : "query", + "name" : "ric_id", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + }, { + "description" : "Select policies owned by a given service.", + "explode" : true, + "in" : "query", + "name" : "service_id", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + }, { + "description" : "Select policies of a given type name (type identity has the format )", + "explode" : true, + "in" : "query", + "name" : "type_name", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "policy_info_list" : { + "$ref" : "#/components/examples/policy_info_list" + } + }, + "schema" : { + "$ref" : "#/components/schemas/policy_info_list" + } + } + }, + "description" : "OK - Returns A1 Policies which matches the criteria" + }, + "404" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/error_information" + } + } + }, + "description" : "Not Found - Near-RT RIC, policy type or service not found" + } + }, + "summary" : "Query for A1 policy instances", + "tags" : [ "A1 Policy Management" ] + } + }, + "/example-authz-check" : { + "post" : { + "description" : "The authorization function decides if access is granted.", + "operationId" : "performAccessControl", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/policy_authorization" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/authorization_result" + } + } + }, + "description" : "OK" + }, + "403" : { + "content" : { + "application/problem+json" : { + "example" : { + "status" : 403, + "title" : "Forbidden", + "detail" : "Your role does not allow to perform this action. Contact System Administrator to change your access rights." + }, + "schema" : { + "$ref" : "#/components/schemas/error_information" + } + } + }, + "description" : "Forbidden" + } + }, + "summary" : "Request for access authorization.", + "tags" : [ "Authorization API" ] + } + }, + "/actuator/threaddump" : { + "get" : { + "operationId" : "threaddump", + "responses" : { + "200" : { + "content" : { + "text/plain;charset=UTF-8" : { + "schema" : { + "type" : "object" + } + }, + "application/vnd.spring-boot.actuator.v3+json" : { + "schema" : { + "type" : "object" + } + }, + "application/json" : { + "schema" : { + "type" : "object" + } + }, + "application/vnd.spring-boot.actuator.v2+json" : { + "schema" : { + "type" : "object" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Actuator web endpoint 'threaddump'", + "tags" : [ "Actuator" ], + "x-internal" : true + } + }, + "/a1-policy/v2/status" : { + "get" : { + "description" : "Returns status and statistics of this service", + "operationId" : "getStatus", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "status_info" : { + "$ref" : "#/components/examples/status_info" + } + }, + "schema" : { + "$ref" : "#/components/schemas/status_info" + } + } + }, + "description" : "OK- Service is living Ok" + } + }, + "tags" : [ "Health Check" ] + } + }, + "/actuator/loggers" : { + "get" : { + "operationId" : "loggers", + "responses" : { + "200" : { + "content" : { + "application/vnd.spring-boot.actuator.v3+json" : { + "schema" : { + "type" : "object" + } + }, + "application/json" : { + "schema" : { + "type" : "object" + } + }, + "application/vnd.spring-boot.actuator.v2+json" : { + "schema" : { + "type" : "object" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Actuator web endpoint 'loggers'", + "tags" : [ "Actuator" ], + "x-internal" : true + } + }, + "/actuator/health/**" : { + "get" : { + "operationId" : "health-path", + "responses" : { + "200" : { + "content" : { + "application/vnd.spring-boot.actuator.v3+json" : { + "schema" : { + "type" : "object" + } + }, + "application/json" : { + "schema" : { + "type" : "object" + } + }, + "application/vnd.spring-boot.actuator.v2+json" : { + "schema" : { + "type" : "object" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Actuator web endpoint 'health-path'", + "tags" : [ "Actuator" ], + "x-internal" : true + } + }, + "/a1-policy/v2/rics/ric" : { + "get" : { + "description" : "Either a Near-RT RIC identity or a Managed Element identity can be specified.
The intention with Managed Element identity is the ID used in O1 for accessing the traffical element (such as the ID of CU).", + "operationId" : "getRic", + "parameters" : [ { + "description" : "The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.", + "explode" : true, + "in" : "query", + "name" : "managed_element_id", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + }, { + "description" : "The identity of a Near-RT RIC to get information for.", + "explode" : true, + "in" : "query", + "name" : "ric_id", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "ric_info" : { + "$ref" : "#/components/examples/ric_info" + } + }, + "schema" : { + "$ref" : "#/components/schemas/ric_info" + } + } + }, + "description" : "OK - Near-RT RIC is found" + }, + "404" : { + "content" : { + "application/problem+json" : { + "example" : [ ] + } + }, + "description" : "Not Found" + } + }, + "summary" : "Returns info of Near-RT RIC queried by the ric-id and managed-element-id", + "tags" : [ "NearRT-RIC Repository" ] + } + }, + "/actuator/shutdown" : { + "post" : { + "operationId" : "shutdown", + "responses" : { + "200" : { + "content" : { + "application/vnd.spring-boot.actuator.v3+json" : { + "schema" : { + "type" : "object" + } + }, + "application/json" : { + "schema" : { + "type" : "object" + } + }, + "application/vnd.spring-boot.actuator.v2+json" : { + "schema" : { + "type" : "object" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Actuator web endpoint 'shutdown'", + "tags" : [ "Actuator" ], + "x-internal" : true + } + }, + "/a1-policy/v2/policy-types" : { + "get" : { + "description" : "Query policy type identities", + "operationId" : "getPolicyTypes", + "parameters" : [ { + "description" : "Select types for the given Near-RT RIC identity.", + "explode" : true, + "in" : "query", + "name" : "ric_id", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + }, { + "description" : "Select types with the given type name (type identity has the format )", + "explode" : true, + "in" : "query", + "name" : "type_name", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + }, { + "description" : "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.", + "explode" : true, + "in" : "query", + "name" : "compatible_with_version", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "policy_type_id_list" : { + "$ref" : "#/components/examples/policy_type_id_list" + } + }, + "schema" : { + "$ref" : "#/components/schemas/policy_type_id_list" + } + } + }, + "description" : "OK - Policy Type IDs Found" + }, + "404" : { + "content" : { + "application/problem+json" : { + "example" : [ ] + } + }, + "description" : "Not Found" + } + }, + "tags" : [ "A1 Policy Management" ] + } + }, + "/a1-policy/v2/policies/{policy_id}" : { + "delete" : { + "description" : "Deleting the policy using the Policy's Policy ID.", + "operationId" : "deletePolicy", + "parameters" : [ { + "explode" : false, + "in" : "path", + "name" : "policy_id", + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } ], + "responses" : { + "200" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/void" + } + } + }, + "description" : "OK - Policy deleted" + }, + "423" : { + "content" : { + "application/problem+json" : { + "example" : { + "status" : 423, + "title" : "Locked", + "detail" : "Requested resource is in a locked state." + }, + "schema" : { + "$ref" : "#/components/schemas/error_information" + } + } + }, + "description" : "Locked - HTTP Status code which can be used when the state is Locked" + } + }, + "summary" : "Delete a policy", + "tags" : [ "A1 Policy Management" ] + }, + "get" : { + "description" : "Returns a policy", + "operationId" : "getPolicy", + "parameters" : [ { + "explode" : false, + "in" : "path", + "name" : "policy_id", + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "policy_info" : { + "$ref" : "#/components/examples/policy_info" + } + }, + "schema" : { + "$ref" : "#/components/schemas/policy_info" + } + } + }, + "description" : "OK - Policy found" + }, + "404" : { + "content" : { + "application/problem+json" : { + "example" : [ ] + } + }, + "description" : "Not Found" + } + }, + "tags" : [ "A1 Policy Management" ] + } + }, + "/actuator/metrics/{requiredMetricName}" : { + "get" : { + "operationId" : "metrics-requiredMetricName", + "parameters" : [ { + "explode" : false, + "in" : "path", + "name" : "requiredMetricName", + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.spring-boot.actuator.v3+json" : { + "schema" : { + "type" : "object" + } + }, + "application/json" : { + "schema" : { + "type" : "object" + } + }, + "application/vnd.spring-boot.actuator.v2+json" : { + "schema" : { + "type" : "object" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Actuator web endpoint 'metrics-requiredMetricName'", + "tags" : [ "Actuator" ], + "x-internal" : true + } + }, + "/a1-policy/v2/configuration" : { + "get" : { + "description" : "Returns the contents of the application configuration file", + "operationId" : "getConfiguration", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "OK - Configuration" + }, + "404" : { + "content" : { + "application/problem+json" : { + "example" : [ ] + } + }, + "description" : "Not Found" + } + }, + "tags" : [ "Configuration" ] + }, + "put" : { + "description" : "Replace the current configuration with the given configuration", + "operationId" : "putConfiguration", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "object" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/void" + } + } + }, + "description" : "OK - Configuration updated" + }, + "400" : { + "content" : { + "application/problem+json" : { + "example" : { + "status" : 400, + "title" : "Bad Request", + "detail" : "The provided request is not valid." + }, + "schema" : { + "$ref" : "#/components/schemas/error_information" + } + } + }, + "description" : "Bad Request" + } + }, + "tags" : [ "Configuration" ] + } + }, + "/actuator" : { + "get" : { + "operationId" : "links", + "responses" : { + "200" : { + "content" : { + "application/vnd.spring-boot.actuator.v3+json" : { + "schema" : { + "additionalProperties" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/Link" + }, + "type" : "object" + }, + "type" : "object" + } + }, + "application/json" : { + "schema" : { + "additionalProperties" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/Link" + }, + "type" : "object" + }, + "type" : "object" + } + }, + "application/vnd.spring-boot.actuator.v2+json" : { + "schema" : { + "additionalProperties" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/Link" + }, + "type" : "object" + }, + "type" : "object" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Actuator root web endpoint", + "tags" : [ "Actuator" ], + "x-internal" : true + } + }, + "/actuator/loggers/{name}" : { + "get" : { + "operationId" : "loggers-name", + "parameters" : [ { + "explode" : false, + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.spring-boot.actuator.v3+json" : { + "schema" : { + "type" : "object" + } + }, + "application/json" : { + "schema" : { + "type" : "object" + } + }, + "application/vnd.spring-boot.actuator.v2+json" : { + "schema" : { + "type" : "object" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Actuator web endpoint 'loggers-name'", + "tags" : [ "Actuator" ], + "x-internal" : true + }, + "post" : { + "operationId" : "loggers-name_2", + "parameters" : [ { + "explode" : false, + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "enum" : [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL", "OFF" ], + "type" : "string" + } + } + } + }, + "responses" : { + "200" : { + "content" : { + "*/*" : { + "schema" : { + "type" : "object" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Actuator web endpoint 'loggers-name'", + "tags" : [ "Actuator" ], + "x-internal" : true + } + }, + "/a1-policy/v2/services/{service_id}/keepalive" : { + "put" : { + "description" : "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)", + "operationId" : "keepAliveService", + "parameters" : [ { + "explode" : false, + "in" : "path", + "name" : "service_id", + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } ], + "responses" : { + "200" : { + "content" : { + "*/*" : { + "schema" : { + "type" : "object" + } + } + }, + "description" : "OK - Service supervision timer refreshed, OK" + }, + "404" : { + "content" : { + "application/problem+json" : { + "example" : [ ] + } + }, + "description" : "Not Found" + } + }, + "summary" : "Heartbeat indicates that the service is running", + "tags" : [ "Service Registry and Supervision" ] + } + }, + "/actuator/metrics" : { + "get" : { + "operationId" : "metrics", + "responses" : { + "200" : { + "content" : { + "application/vnd.spring-boot.actuator.v3+json" : { + "schema" : { + "type" : "object" + } + }, + "application/json" : { + "schema" : { + "type" : "object" + } + }, + "application/vnd.spring-boot.actuator.v2+json" : { + "schema" : { + "type" : "object" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Actuator web endpoint 'metrics'", + "tags" : [ "Actuator" ], + "x-internal" : true + } + }, + "/a1-policy/v2/rics" : { + "get" : { + "description" : "The call returns all Near-RT RICs that supports a given policy type identity", + "operationId" : "getRics", + "parameters" : [ { + "description" : "The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned", + "explode" : true, + "in" : "query", + "name" : "policytype_id", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "ric_info_list" : { + "$ref" : "#/components/examples/ric_info_list" + } + }, + "schema" : { + "$ref" : "#/components/schemas/ric_info_list" + } + } + }, + "description" : "OK" + }, + "404" : { + "content" : { + "application/problem+json" : { + "example" : [ ] + } + }, + "description" : "Not Found" + } + }, + "summary" : "Query Near-RT RIC information", + "tags" : [ "NearRT-RIC Repository" ] + } + }, + "/a1-policy/v2/services" : { + "get" : { + "description" : "Either information about a registered service with given identity or all registered services are returned.", + "operationId" : "getServices", + "parameters" : [ { + "description" : "The identity of the service", + "explode" : true, + "in" : "query", + "name" : "service_id", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "service_status_list" : { + "$ref" : "#/components/examples/service_status_list" + } + }, + "schema" : { + "$ref" : "#/components/schemas/service_status_list" + } + } + }, + "description" : "OK" + }, + "404" : { + "content" : { + "application/problem+json" : { + "example" : [ ] + } + }, + "description" : "Not Found" + } + }, + "summary" : "Returns service information", + "tags" : [ "Service Registry and Supervision" ] + }, + "put" : { + "callbacks" : { + "RICStatus" : { + "{$request.body#/callback_url}" : { + "post" : { + "description" : "The URL to this call is registered at Service registration.", + "operationId" : "serviceCallback", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/service_callback_info_v2" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/void" + } + } + }, + "description" : "OK" + }, + "404" : { + "content" : { + "application/problem+json" : { + "example" : [ ] + } + }, + "description" : "Not Found" + } + }, + "summary" : "Callback for Near-RT RIC status", + "tags" : [ "Service callbacks" ] + } + } + } + }, + "description" : "Registering a service is needed to:

Get callbacks about available NearRT RICs.
Activate supervision of the service. If a service is inactive, its policies will automatically be deleted.

Policies can be created even if the service is not registerred. This is a feature which it is optional to use.", + "operationId" : "putService", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/service_registration_info" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "*/*" : { + "schema" : { + "type" : "object" + } + } + }, + "description" : "OK - Service updated" + }, + "201" : { + "content" : { + "*/*" : { + "schema" : { + "type" : "object" + } + } + }, + "description" : "Created - Service created" + }, + "400" : { + "content" : { + "application/problem+json" : { + "example" : { + "status" : 400, + "title" : "Bad Request", + "detail" : "The provided request is not valid." + }, + "schema" : { + "$ref" : "#/components/schemas/error_information" + } + } + }, + "description" : "Bad Request" + } + }, + "summary" : "Register a service", + "tags" : [ "Service Registry and Supervision" ] + } + }, + "/actuator/info" : { + "get" : { + "operationId" : "info", + "responses" : { + "200" : { + "content" : { + "application/vnd.spring-boot.actuator.v3+json" : { + "schema" : { + "type" : "object" + } + }, + "application/json" : { + "schema" : { + "type" : "object" + } + }, + "application/vnd.spring-boot.actuator.v2+json" : { + "schema" : { + "type" : "object" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Actuator web endpoint 'info'", + "tags" : [ "Actuator" ], + "x-internal" : true + } + }, + "/status" : { + "get" : { + "description" : "Returns status and statistics of this service", + "operationId" : "getStatusV1", + "responses" : { + "200" : { + "content" : { + "*/*" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "OK - Service is living" + } + }, + "tags" : [ "Health Check" ] + } + }, + "/a1-policy/v2/policy-types/{policytype_id}" : { + "get" : { + "description" : "Returns a policy type definition", + "operationId" : "getPolicyTypeDefinition", + "parameters" : [ { + "explode" : false, + "in" : "path", + "name" : "policytype_id", + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "policy_type_definition" : { + "$ref" : "#/components/examples/policy_type_definition" + } + }, + "schema" : { + "$ref" : "#/components/schemas/policy_type_definition" + } + } + }, + "description" : "OK - schema of the given policy type" + }, + "404" : { + "content" : { + "application/problem+json" : { + "example" : [ ] + } + }, + "description" : "Not Found" + } + }, + "tags" : [ "A1 Policy Management" ] + } + }, + "/actuator/logfile" : { + "get" : { + "operationId" : "logfile", + "responses" : { + "200" : { + "content" : { + "text/plain;charset=UTF-8" : { + "schema" : { + "type" : "object" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Actuator web endpoint 'logfile'", + "tags" : [ "Actuator" ], + "x-internal" : true + } + }, + "/actuator/health" : { + "get" : { + "operationId" : "health", + "responses" : { + "200" : { + "content" : { + "application/vnd.spring-boot.actuator.v3+json" : { + "schema" : { + "type" : "object" + } + }, + "application/json" : { + "schema" : { + "type" : "object" + } + }, + "application/vnd.spring-boot.actuator.v2+json" : { + "schema" : { + "type" : "object" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Actuator web endpoint 'health'", + "tags" : [ "Actuator" ], + "x-internal" : true + } + }, + "/a1-policy/v2/policies" : { + "get" : { + "description" : "Returns a list of A1 policies matching given search criteria.
If several query parameters are defined, the policies matching all conditions are returned.", + "operationId" : "getPolicyIds", + "parameters" : [ { + "description" : "Select policies of a given policy type identity.", + "explode" : true, + "in" : "query", + "name" : "policytype_id", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + }, { + "description" : "Select policies of a given Near-RT RIC identity.", + "explode" : true, + "in" : "query", + "name" : "ric_id", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + }, { + "description" : "Select policies owned by a given service.", + "explode" : true, + "in" : "query", + "name" : "service_id", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + }, { + "description" : "Select policies of types with the given type name (type identity has the format )", + "explode" : true, + "in" : "query", + "name" : "type_name", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "policy_id_list" : { + "$ref" : "#/components/examples/policy_id_list" + } + }, + "schema" : { + "$ref" : "#/components/schemas/policy_id_list" + } + } + }, + "description" : "OK - Policy identities" + }, + "404" : { + "content" : { + "application/problem+json" : { + "example" : [ ] + } + }, + "description" : "Not Found" + } + }, + "summary" : "Query policy identities", + "tags" : [ "A1 Policy Management" ] + }, + "put" : { + "description" : "Create or update a policy", + "operationId" : "putPolicy", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/policy_info" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/void" + } + } + }, + "description" : "OK - Policy updated" + }, + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/void" + } + } + }, + "description" : "Created - Policy created" + }, + "423" : { + "content" : { + "application/problem+json" : { + "example" : { + "status" : 423, + "title" : "Locked", + "detail" : "Requested resource is in a locked state." + }, + "schema" : { + "$ref" : "#/components/schemas/error_information" + } + } + }, + "description" : "Locked - HTTP Status code which can be used when the state is Locked" + } + }, + "tags" : [ "A1 Policy Management" ] + } + }, + "/a1-policy/v2/services/{service_id}" : { + "delete" : { + "description" : "Unregister a service", + "operationId" : "deleteService", + "parameters" : [ { + "explode" : false, + "in" : "path", + "name" : "service_id", + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } ], + "responses" : { + "204" : { + "content" : { + "*/*" : { + "schema" : { + "type" : "object" + } + } + }, + "description" : "No Content - Service unregistered" + }, + "404" : { + "content" : { + "application/problem+json" : { + "example" : [ ] + } + }, + "description" : "Not Found" + } + }, + "tags" : [ "Service Registry and Supervision" ] + } + }, + "/actuator/heapdump" : { + "get" : { + "operationId" : "heapdump", + "responses" : { + "200" : { + "content" : { + "application/octet-stream" : { + "schema" : { + "type" : "object" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Actuator web endpoint 'heapdump'", + "tags" : [ "Actuator" ], + "x-internal" : true + } + }, + "/a1-policy/v2/policies/{policy_id}/status" : { + "get" : { + "description" : "Returns a policy status", + "operationId" : "getPolicyStatus", + "parameters" : [ { + "explode" : false, + "in" : "path", + "name" : "policy_id", + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "policy_status_info" : { + "$ref" : "#/components/examples/policy_status_info" + } + }, + "schema" : { + "$ref" : "#/components/schemas/policy_status_info" + } + } + }, + "description" : "OK - Policy status" + }, + "404" : { + "content" : { + "application/problem+json" : { + "example" : [ ] + } + }, + "description" : "Not Found" + } + }, + "tags" : [ "A1 Policy Management" ] + } + } + }, + "components" : { + "examples" : { + "service_status" : { + "description" : "List of service information", + "value" : { + "callback_url" : "callback_url", + "service_id" : "service_id", + "keep_alive_interval_seconds" : 0, + "time_since_last_activity_seconds" : 6 + } + }, + "service_status_list" : { + "description" : "List of service information", + "value" : { + "service_list" : [ { + "callback_url" : "callback_url", + "service_id" : "service_id", + "keep_alive_interval_seconds" : 0, + "time_since_last_activity_seconds" : 6 + }, { + "callback_url" : "callback_url", + "service_id" : "service_id", + "keep_alive_interval_seconds" : 0, + "time_since_last_activity_seconds" : 6 + } ] + } + }, + "policy_type_definition" : { + "description" : "Schema of the given Policy type", + "value" : { + "policy_schema" : "{}" + } + }, + "policy_type_id_list" : { + "description" : "Array of policy type id's", + "value" : { + "policy_type_id_list" : [ "policytype_id", "policytype_id" ] + } + }, + "policy_info" : { + "description" : "Policy information of one A1-P policy", + "value" : { + "ric_id" : "ric_id", + "policy_id" : "policy_id", + "transient" : false, + "service_id" : "service_id", + "policy_data" : "{}", + "status_notification_uri" : "status_notification_uri", + "policytype_id" : "policytype_id" + } + }, + "policy_info_list" : { + "description" : "List of policy information", + "value" : { + "policies" : [ { + "ric_id" : "ric_id", + "policy_id" : "policy_id", + "transient" : false, + "service_id" : "service_id", + "policy_data" : "{}", + "status_notification_uri" : "status_notification_uri", + "policytype_id" : "policytype_id" + }, { + "ric_id" : "ric_id", + "policy_id" : "policy_id", + "transient" : false, + "service_id" : "service_id", + "policy_data" : "{}", + "status_notification_uri" : "status_notification_uri", + "policytype_id" : "policytype_id" + } ] + } + }, + "policy_id_list" : { + "description" : "A list of policy identities", + "value" : { + "policy_ids" : [ "some_policy_id", "some_policy_id" ] + } + }, + "policy_status_info" : { + "description" : "Status for one A1-P Policy", + "value" : { + "last_modified" : "last_modified", + "status" : { + "value" : { + "status" : "status" + } + } + } + }, + "status_info" : { + "value" : { + "status" : "status" + } + }, + "ric_info" : { + "value" : { + "ric_id" : "ric_id", + "managed_element_ids" : [ "some_managed_element_id", "some_managed_element_id" ], + "state" : "UNAVAILABLE", + "policytype_ids" : [ "some_policytype_id", "some_policytype_id" ] + } + }, + "ric_info_list" : { + "value" : { + "rics" : [ { + "ric_id" : "ric_id", + "managed_element_ids" : [ "some_managed_element_id", "some_managed_element_id" ], + "state" : "UNAVAILABLE", + "policytype_ids" : [ "policytype_id", "policytype_id" ] + }, { + "ric_id" : "ric_id", + "managed_element_ids" : [ "managed_element_ids", "managed_element_ids" ], + "state" : "UNAVAILABLE", + "policytype_ids" : [ "policytype_ids", "policytype_ids" ] + } ] + } + } + }, + "responses" : { + "Locked" : { + "content" : { + "application/problem+json" : { + "example" : { + "status" : 423, + "title" : "Locked", + "detail" : "Requested resource is in a locked state." + }, + "schema" : { + "$ref" : "#/components/schemas/error_information" + } + } + }, + "description" : "Locked - HTTP Status code which can be used when the state is Locked" + }, + "BadRequest" : { + "content" : { + "application/problem+json" : { + "example" : { + "status" : 400, + "title" : "Bad Request", + "detail" : "The provided request is not valid." + }, + "schema" : { + "$ref" : "#/components/schemas/error_information" + } + } + }, + "description" : "Bad Request" + }, + "Forbidden" : { + "content" : { + "application/problem+json" : { + "example" : { + "status" : 403, + "title" : "Forbidden", + "detail" : "Your role does not allow to perform this action. Contact System Administrator to change your access rights." + }, + "schema" : { + "$ref" : "#/components/schemas/error_information" + } + } + }, + "description" : "Forbidden" + }, + "NotFound" : { + "content" : { + "application/problem+json" : { + "example" : [ ] + } + }, + "description" : "Not Found" + } + }, + "schemas" : { + "policy_type_definition" : { + "description" : "Contains policy type schema definition", + "properties" : { + "policy_schema" : { + "description" : "Policy type json schema. The schema is a json object following http://json-schema.org/draft-07/schema", + "type" : "object" + } + }, + "type" : "object" + }, + "error_information" : { + "description" : "Problem as defined in https://tools.ietf.org/html/rfc7807", + "properties" : { + "detail" : { + "description" : " A human-readable explanation specific to this occurrence of the problem.", + "example" : "Policy type not found", + "type" : "string" + }, + "title" : { + "description" : "A specific error name", + "example" : "Not Found", + "type" : "string" + }, + "status" : { + "description" : "The HTTP status code generated by the origin server for this occurrence of the problem. ", + "example" : 404, + "format" : "int32", + "type" : "integer" + } + }, + "type" : "object" + }, + "void" : { + "description" : "Void/empty", + "type" : "object" + }, + "status_info" : { + "properties" : { + "status" : { + "description" : "status text", + "type" : "string" + } + }, + "type" : "object" + }, + "authorization_result" : { + "description" : "Result of authorization", + "example" : { + "result" : true + }, + "properties" : { + "result" : { + "description" : "If true, the access is granted", + "type" : "boolean" + } + }, + "required" : [ "result" ], + "type" : "object" + }, + "ric_info" : { + "description" : "Information for a Near-RT RIC", + "properties" : { + "ric_id" : { + "description" : "identity of the Near-RT RIC", + "type" : "string" + }, + "managed_element_ids" : { + "description" : "O1 identities for managed entities", + "items" : { + "description" : "O1 identities for managed entities", + "type" : "string" + }, + "type" : "array" + }, + "state" : { + "description" : "Represents the states for a Near-RT RIC", + "enum" : [ "UNAVAILABLE", "AVAILABLE", "SYNCHRONIZING", "CONSISTENCY_CHECK" ], + "type" : "string" + }, + "policytype_ids" : { + "description" : "supported policy types", + "items" : { + "description" : "supported policy types", + "type" : "string" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "service_registration_info" : { + "description" : "Information for one service", + "properties" : { + "callback_url" : { + "description" : "callback for notifying of Near-RT RIC state changes", + "type" : "string" + }, + "service_id" : { + "description" : "identity of the service", + "type" : "string" + }, + "keep_alive_interval_seconds" : { + "description" : "keep alive interval for the service. This is used to enable optional heartbeat supervision of the service. If set (> 0) the registered service should regularly invoke a 'keepalive' REST call. When a service fails to invoke this 'keepalive' call within the configured time, the service is considered unavailable. An unavailable service will be automatically deregistered and its policies will be deleted. Value 0 means timeout supervision is disabled.", + "format" : "int64", + "type" : "integer" + } + }, + "required" : [ "service_id" ], + "type" : "object" + }, + "policy_info_list" : { + "description" : "List of policy information", + "properties" : { + "policies" : { + "description" : "List of policy information", + "items" : { + "$ref" : "#/components/schemas/policy_info" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "policy_status_info" : { + "description" : "Status for one A1-P Policy", + "properties" : { + "last_modified" : { + "description" : "timestamp, last modification time", + "type" : "string" + }, + "status" : { + "description" : "the Policy status", + "type" : "object" + } + }, + "type" : "object" + }, + "service_status" : { + "properties" : { + "callback_url" : { + "description" : "callback for notifying of RIC synchronization", + "type" : "string" + }, + "service_id" : { + "description" : "identity of the service", + "type" : "string" + }, + "keep_alive_interval_seconds" : { + "description" : "policy keep alive timeout", + "format" : "int64", + "type" : "integer" + }, + "time_since_last_activity_seconds" : { + "description" : "time since last invocation by the service", + "format" : "int64", + "type" : "integer" + } + }, + "type" : "object" + }, + "ric_info_list" : { + "description" : "List of Near-RT RIC information", + "properties" : { + "rics" : { + "description" : "List of Near-RT RIC information", + "items" : { + "$ref" : "#/components/schemas/ric_info" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "input" : { + "description" : "input", + "properties" : { + "access_type" : { + "description" : "Access type", + "enum" : [ "READ", "WRITE", "DELETE" ], + "type" : "string" + }, + "auth_token" : { + "description" : "Authorization token", + "type" : "string" + }, + "policy_type_id" : { + "description" : "Policy type identifier", + "type" : "string" + } + }, + "required" : [ "access_type", "auth_token", "policy_type_id" ], + "type" : "object" + }, + "policy_authorization" : { + "description" : "Authorization request for A1 policy requests", + "properties" : { + "input" : { + "$ref" : "#/components/schemas/input" + } + }, + "required" : [ "input" ], + "type" : "object" + }, + "policy_type_id_list" : { + "description" : "Information about policy types", + "properties" : { + "policytype_ids" : { + "description" : "Policy type identities", + "items" : { + "description" : "Policy type identities", + "type" : "string" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "policy_info" : { + "description" : "Information for one A1-P Policy", + "properties" : { + "ric_id" : { + "description" : "identity of the target Near-RT RIC", + "type" : "string" + }, + "policy_id" : { + "description" : "identity of the policy", + "type" : "string" + }, + "transient" : { + "default" : false, + "description" : "if true, the policy is deleted at RIC restart. If false, its value is maintained by this service until explicitly deleted. Default false.", + "example" : false, + "nullable" : false, + "type" : "boolean" + }, + "service_id" : { + "default" : "", + "description" : "the identity of the service owning the policy. This can be used to group the policies (it is possible to get all policies associated to a service). Note that the service does not need to be registered.", + "type" : "string" + }, + "policy_data" : { + "description" : "the configuration of the policy", + "type" : "object" + }, + "status_notification_uri" : { + "description" : "Callback URI for policy status updates", + "type" : "string" + }, + "policytype_id" : { + "description" : "identity of the policy type", + "type" : "string" + } + }, + "required" : [ "policy_data", "policy_id", "policytype_id", "ric_id" ], + "type" : "object" + }, + "policy_id_list" : { + "description" : "A list of policy identities", + "example" : { + "policy_ids" : [ "policy_ids", "policy_ids" ] + }, + "properties" : { + "policy_ids" : { + "description" : "Policy identities", + "items" : { + "description" : "Policy identities", + "type" : "string" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "service_status_list" : { + "properties" : { + "service_list" : { + "description" : "List of service information", + "items" : { + "$ref" : "#/components/schemas/service_status" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "service_callback_info_v2" : { + "description" : "Information transferred as in Service callbacks (callback_url)", + "properties" : { + "ric_id" : { + "description" : "identity of a Near-RT RIC", + "type" : "string" + }, + "event_type" : { + "description" : "values:\nAVAILABLE: the Near-RT RIC has become available for A1 Policy management", + "enum" : [ "AVAILABLE" ], + "type" : "string" + } + }, + "required" : [ "event_type", "ric_id" ], + "type" : "object" + }, + "Link" : { + "properties" : { + "templated" : { + "type" : "boolean" + }, + "href" : { + "type" : "string" + } + }, + "type" : "object" + } + } + } +} \ No newline at end of file diff --git a/a1-policy-management/api/pms-api.yaml b/a1-policy-management/api/offeredapis/swagger/pms-api.yaml similarity index 99% rename from a1-policy-management/api/pms-api.yaml rename to a1-policy-management/api/offeredapis/swagger/pms-api.yaml index 1c25e051..c0b50d4d 100644 --- a/a1-policy-management/api/pms-api.yaml +++ b/a1-policy-management/api/offeredapis/swagger/pms-api.yaml @@ -431,7 +431,6 @@ paths: - Actuator /a1-policy/v2/configuration: get: - x-internal: true operationId: getConfiguration responses: "200": @@ -447,7 +446,6 @@ paths: tags: - Configuration put: - x-internal: true operationId: putConfiguration requestBody: content: diff --git a/a1-policy-management/pom.xml b/a1-policy-management/pom.xml index 82ea4054..798722da 100644 --- a/a1-policy-management/pom.xml +++ b/a1-policy-management/pom.xml @@ -264,6 +264,7 @@ org.springframework.boot spring-boot-actuator-autoconfigure + 3.3.0 @@ -395,9 +396,9 @@ - io.swagger.codegen.v3 - swagger-codegen-maven-plugin - 3.0.46 + org.openapitools + openapi-generator-maven-plugin + 7.7.0 generate-openapi-json @@ -406,21 +407,29 @@ generate - ${project.basedir}/api/pms-api.yaml - openapi - ${project.basedir}/api + ${project.basedir}/api/offeredapis/swagger/pms-api.yaml + openapi + ${project.basedir}/api/offeredapis/swagger - pms-api.json + pms-api.json + + + + + generate-openapi-json-v3 + prepare-package + + generate + + + ${project.basedir}/api/offeredapis/swagger/pms-api-v3.yaml + openapi + ${project.basedir}/api/offeredapis/swagger + + pms-api-v3.json - - - - org.openapitools - openapi-generator-maven-plugin - 6.6.0 - generate-openapi-html prepare-package @@ -428,9 +437,9 @@ generate - ${project.basedir}/api/pms-api.json + ${project.basedir}/api/offeredapis/swagger/pms-api.json html2 - ${project.basedir}/api/pms-api + ${project.basedir}/api/offeredapis/openapitoolgen/offeredapis/pms-api false false @@ -444,6 +453,28 @@ + + generate-openapi-html-v3 + prepare-package + + generate + + + ${project.basedir}/api/offeredapis/swagger/pms-api-v3.json + html2 + ${project.basedir}/api/offeredapis/openapitoolgen/offeredapis/pms-api/v3 + false + false + + The O-RAN Non-RT RIC Policy Management Service + provides a REST API for managing O-RAN A1 Policies. + ONAP CCSDK A1 Policy Management Service + https://wiki.onap.org/display/DW/O-RAN+A1+Policies+in+ONAP + Copyright (C) 2024 OpenInfra Foundation Europe. All rights reserved. + http://www.apache.org/licenses/LICENSE-2.0 + + + generate-policy-api generate-sources @@ -451,7 +482,7 @@ generate - ${project.basedir}/api/pms-api.yaml + ${project.basedir}/api/offeredapis/swagger/pms-api.yaml ${project.groupId}.a1policymanagementservice.controllers.v2 ${project.groupId}.a1policymanagementservice.controllers.api.v2 ${project.groupId}.a1policymanagementservice.models.v2 @@ -481,7 +512,7 @@ generate - ${project.basedir}/api/pms-api-v3.yaml + ${project.basedir}/api/offeredapis/swagger/pms-api-v3.yaml ${project.groupId}.a1policymanagementservice.controllers.v3 ${project.groupId}.a1policymanagementservice.controllers.api.v3 ${project.groupId}.a1policymanagementservice.models.v3 @@ -516,34 +547,18 @@ copy-resources - ${project.basedir}/../docs/offeredapis/swagger + ${project.basedir}/../docs/offeredapis true - ${project.basedir}/api - - pms-api.json - pms-api.yaml - - - - - - - copy-resource-openapi-html - package - - copy-resources - - - true - - ${project.basedir}/../docs/offeredapis/openapitoolgen/offeredapis/pms-api - - - ${project.basedir}/api/pms-api + ${project.basedir}/api/offeredapis - index.html + swagger/pms-api.json + swagger/pms-api.yaml + swagger/pms-api-v3.json + swagger/pms-api-v3.yaml + openapitoolgen/offeredapis/pms-api/index.html + openapitoolgen/offeredapis/pms-api/v3/index.html diff --git a/docs/conf.py b/docs/conf.py index 460f86d1..196f094e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -57,6 +57,12 @@ redoc = [ 'spec': './offeredapis/swagger/pms-api.json', 'embed': True, }, + { + 'name': 'PMS API V3', + 'page': 'offeredapis/pms-api-v3', + 'spec': './offeredapis/swagger/pms-api-v3.json', + 'embed': True, + }, { 'name': 'A1 ADAPTER API', 'page': 'offeredapis/a1-adapter-api', @@ -77,7 +83,7 @@ spelling_word_list_filename='spelling_wordlist.txt' spelling_lang = "en_GB" html_extra_path = [ - 'offeredapis/openapitoolgen/offeredapis/pms-api' + 'offeredapis/openapitoolgen' ] # @@ -91,7 +97,8 @@ def setup(app): app.add_css_file("css/ribbon.css") linkcheck_ignore = [ - r'http://localhost:\d+/', - './a1-adapter-api.html', #Generated file that doesn't exist at link check. - './pms-api.html' #Generated file that doesn't exist at link check. + r'http://localhost:\d+/', + './a1-adapter-api.html', #Generated file that doesn't exist at link check. + './pms-api.html', #Generated file that doesn't exist at link check. + './pms-api-v3.html' #Generated file that doesn't exist at link check. ] diff --git a/docs/offeredapis/offeredapis.rst b/docs/offeredapis/offeredapis.rst index 28f00835..e94b53a2 100644 --- a/docs/offeredapis/offeredapis.rst +++ b/docs/offeredapis/offeredapis.rst @@ -48,6 +48,7 @@ API Table :widths: 10,5, 5 "A1 Policy Management Service API (NBI)", ":download:`link <./swagger/pms-api.json>`", ":download:`link <./swagger/pms-api.yaml>`" + "A1 Policy Management Service API V3 (NBI)", ":download:`link <./swagger/pms-api-v3.json>`", ":download:`link <./swagger/pms-api-v3.yaml>`" "A1 ADAPTER API (Internal)", ":download:`link <./swagger/a1-adapter-api.json>`", ":download:`link <./swagger/a1-adapter-api.yaml>`" .. _pms_api: @@ -56,6 +57,7 @@ A1 Policy Management Service API ................................ The A1 Policy Management Service API is described in more detail in `A1 Policy Management Service API (html) <./pms-api.html>`_ +A1 Policy Management Service API version 3 is described in more detail at `A1 Policy Management Service API V3 (html) <./pms-api-v3.html>`_ .. _a1_adapter_api: diff --git a/docs/offeredapis/openapitoolgen/offeredapis/pms-api/index.html b/docs/offeredapis/openapitoolgen/offeredapis/pms-api/index.html index 66934cda..9580d539 100644 --- a/docs/offeredapis/openapitoolgen/offeredapis/pms-api/index.html +++ b/docs/offeredapis/openapitoolgen/offeredapis/pms-api/index.html @@ -7,10 +7,8 @@ @@ -1197,46 +1196,6 @@ ul.nav-tabs {

putPolicy

- -

- health -

- healthPath -

- heapdump -

- info -

- links -

- logfile -

- loggers -

- loggersName -

- loggersName2 -

- metrics -

- metricsRequiredMetricName -

- shutdown -

- threaddump -

performAccessControl @@ -1318,6 +1277,7 @@ ul.nav-tabs {

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String policyId = new String(); // String | 
+
+try {
+    final result = await api_instance.deletePolicy(policyId);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->deletePolicy: $e\n');
+}
+

- -

+ +

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-A1PolicyManagement-deletePolicy-423-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-A1PolicyManagement-deletePolicy-schema-423'); + result.empty(); + result.append(view.render()); + }); +

+ +

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String policyId = new String(); // String | 
+
+try {
+    final result = await api_instance.getPolicy(policyId);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getPolicy: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-A1PolicyManagement-getPolicy-200-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-A1PolicyManagement-getPolicy-schema-200'); + result.empty(); + result.append(view.render()); + }); +

+ +

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String policytypeId = new String(); // String | Select policies of a given policy type identity.
+final String ricId = new String(); // String | Select policies of a given Near-RT RIC identity.
+final String serviceId = new String(); // String | Select policies owned by a given service.
+final String typeName = new String(); // String | Select policies of types with the given type name (type identity has the format )
+
+try {
+    final result = await api_instance.getPolicyIds(policytypeId, ricId, serviceId, typeName);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getPolicyIds: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-A1PolicyManagement-getPolicyIds-200-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-A1PolicyManagement-getPolicyIds-schema-200'); + result.empty(); + result.append(view.render()); + }); +

+ +

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String policytypeId = new String(); // String | Select policies with a given type identity.
+final String ricId = new String(); // String | Select policies for a given Near-RT RIC identity.
+final String serviceId = new String(); // String | Select policies owned by a given service.
+final String typeName = new String(); // String | Select policies of a given type name (type identity has the format )
+
+try {
+    final result = await api_instance.getPolicyInstances(policytypeId, ricId, serviceId, typeName);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getPolicyInstances: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-A1PolicyManagement-getPolicyInstances-200-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-A1PolicyManagement-getPolicyInstances-schema-200'); + result.empty(); + result.append(view.render()); + }); +

+ +

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-A1PolicyManagement-getPolicyInstances-404-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-A1PolicyManagement-getPolicyInstances-schema-404'); + result.empty(); + result.append(view.render()); + }); +

+ +

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String policyId = new String(); // String | 
+
+try {
+    final result = await api_instance.getPolicyStatus(policyId);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getPolicyStatus: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-A1PolicyManagement-getPolicyStatus-200-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-A1PolicyManagement-getPolicyStatus-schema-200'); + result.empty(); + result.append(view.render()); + }); +

+ +

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String policytypeId = new String(); // String | 
+
+try {
+    final result = await api_instance.getPolicyTypeDefinition(policytypeId);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getPolicyTypeDefinition: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-A1PolicyManagement-getPolicyTypeDefinition-200-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-A1PolicyManagement-getPolicyTypeDefinition-schema-200'); + result.empty(); + result.append(view.render()); + }); +

+ +

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String ricId = new String(); // String | Select types for the given Near-RT RIC identity.
+final String typeName = new String(); // String | Select types with the given type name (type identity has the format )
+final String compatibleWithVersion = new String(); // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order.
+
+try {
+    final result = await api_instance.getPolicyTypes(ricId, typeName, compatibleWithVersion);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getPolicyTypes: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-A1PolicyManagement-getPolicyTypes-200-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-A1PolicyManagement-getPolicyTypes-schema-200'); + result.empty(); + result.append(view.render()); + }); +

+ +

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final PolicyInfo policyInfo = new PolicyInfo(); // PolicyInfo | 
+
+try {
+    final result = await api_instance.putPolicy(policyInfo);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->putPolicy: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-A1PolicyManagement-putPolicy-200-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-A1PolicyManagement-putPolicy-schema-200'); + result.empty(); + result.append(view.render()); + }); +

+ +

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-A1PolicyManagement-putPolicy-201-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-A1PolicyManagement-putPolicy-schema-201'); + result.empty(); + result.append(view.render()); + }); +

+ +

- -

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

- - - -

- Schema -

- - -

- -

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

- - - -

- Schema -

- - -

- -

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

- - - -

- Schema -

- - -

- -

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

- - - -

- Schema -

- - -

- -

links

Actuator root web endpoint

-
-

/actuator

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"
-

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 {
-            map['String', map['String', Link]] result = apiInstance.links();
-            System.out.println(result);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling ActuatorApi#links");
-            e.printStackTrace();
-        }
-    }
-}
-

- -

import org.openapitools.client.api.ActuatorApi;
-
-public class ActuatorApiExample {
-    public static void main(String[] args) {
-        ActuatorApi apiInstance = new ActuatorApi();
-
-        try {
-            map['String', map['String', Link]] result = apiInstance.links();
-            System.out.println(result);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling ActuatorApi#links");
-            e.printStackTrace();
-        }
-    }
-}

- -


-
-// Create an instance of the API class
-ActuatorApi *apiInstance = [[ActuatorApi alloc] init];
-
-// Actuator root web endpoint
-[apiInstance linksWithCompletionHandler: 
-              ^(map['String', map['String', Link]] 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.links(callback);
-

- - -

using System;
-using System.Diagnostics;
-using Org.OpenAPITools.Api;
-using Org.OpenAPITools.Client;
-using Org.OpenAPITools.Model;
-
-namespace Example
-{
-    public class linksExample
-    {
-        public void main()
-        {
-
-            // Create an instance of the API class
-            var apiInstance = new ActuatorApi();
-
-            try {
-                // Actuator root web endpoint
-                map['String', map['String', Link]] result = apiInstance.links();
-                Debug.WriteLine(result);
-            } catch (Exception e) {
-                Debug.Print("Exception when calling ActuatorApi.links: " + 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->links();
-    print_r($result);
-} catch (Exception $e) {
-    echo 'Exception when calling ActuatorApi->links: ', $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->links();
-    print Dumper($result);
-};
-if ($@) {
-    warn "Exception when calling ActuatorApi->links: $@\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 root web endpoint
-    api_response = api_instance.links()
-    pprint(api_response)
-except ApiException as e:
-    print("Exception when calling ActuatorApi->links: %s\n" % e)

- -

extern crate ActuatorApi;
-
-pub fn main() {
-
-    let mut context = ActuatorApi::Context::default();
-    let result = client.links(&context).wait();
-
-    println!("{:?}", result);
-}
-

- -

Scopes

- - -

- -

Parameters

- - - - - - -

Responses

- - - -

- Schema -

- - -

- -

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

- - - -

- Schema -

- - -

- -

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

- - - -

- Schema -

- - -

- -

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

- - - -

- Schema -

- - -

- -

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

- - - -

- Schema -

- - -

- -

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

- - - -

- Schema -

- - -

- -

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

- - - -

- Schema -

- - -

- -

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

- - - -

- Schema -

- - -

- -

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);
+                              
+                                
+                                  
-
-
-                            
-                                
-                                  Schema
-                                
-
-
-
-
-                            
-
-
-                            
-                                
-                                  
-                                    
-                                  
-                                  
+                                      } else if (schema.items != null && schema.items.$ref != null) {
+                                        schema.items = defsParser.$refs.get(schema.items.$ref);
+                                      } else {
+                                        schemaWrapper.definitions = Object.assign({}, defs);
+                                        $RefParser.dereference(schemaWrapper).catch(function(err) {
+                                          console.log(err);
+                                        });
+                                      }
+
+                                      var view = new JSONSchemaView(schema, 3);
+                                      $('#responses-A1PolicyManagement-putPolicy-423-schema-data').val(JSON.stringify(schema));
+                                      var result = $('#responses-A1PolicyManagement-putPolicy-schema-423');
+                                      result.empty();
+                                      result.append(view.render());
+                                    });
+                                  
                                 
+                                
+


@@ -8638,6 +5159,7 @@ pub fn main() {


                           Curl
                           Java
+                          Dart
                           Android
                           
                           Obj-C
@@ -8684,6 +5206,23 @@ public class AuthorizationAPIApiExample {
         }
     }
 }
+

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final PolicyAuthorization policyAuthorization = new PolicyAuthorization(); // PolicyAuthorization | 
+
+try {
+    final result = await api_instance.performAccessControl(policyAuthorization);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->performAccessControl: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-AuthorizationAPI-performAccessControl-200-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-AuthorizationAPI-performAccessControl-schema-200'); + result.empty(); + result.append(view.render()); + }); +

+ +

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-AuthorizationAPI-performAccessControl-403-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-AuthorizationAPI-performAccessControl-schema-403'); + result.empty(); + result.append(view.render()); + }); +

+ +

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+
+try {
+    final result = await api_instance.getConfiguration();
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getConfiguration: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-Configuration-getConfiguration-200-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-Configuration-getConfiguration-schema-200'); + result.empty(); + result.append(view.render()); + }); +

+ +

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final Object body = new Object(); // Object | 
+
+try {
+    final result = await api_instance.putConfiguration(body);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->putConfiguration: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-Configuration-putConfiguration-200-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-Configuration-putConfiguration-schema-200'); + result.empty(); + result.append(view.render()); + }); +

+ +

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-Configuration-putConfiguration-400-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-Configuration-putConfiguration-schema-400'); + result.empty(); + result.append(view.render()); + }); +

+ +

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+
+try {
+    final result = await api_instance.getStatus();
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getStatus: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-HealthCheck-getStatus-200-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-HealthCheck-getStatus-schema-200'); + result.empty(); + result.append(view.render()); + }); +

+ +

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+
+try {
+    final result = await api_instance.getStatusV1();
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getStatusV1: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-HealthCheck-getStatusV1-200-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-HealthCheck-getStatusV1-schema-200'); + result.empty(); + result.append(view.render()); + }); +

+ +

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String managedElementId = new String(); // String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
+final String ricId = new String(); // String | The identity of a Near-RT RIC to get information for.
+
+try {
+    final result = await api_instance.getRic(managedElementId, ricId);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getRic: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-NearRTRICRepository-getRic-200-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-NearRTRICRepository-getRic-schema-200'); + result.empty(); + result.append(view.render()); + }); +

+ +

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String policytypeId = new String(); // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
+
+try {
+    final result = await api_instance.getRics(policytypeId);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getRics: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-NearRTRICRepository-getRics-200-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-NearRTRICRepository-getRics-schema-200'); + result.empty(); + result.append(view.render()); + }); +

+ +

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String serviceId = new String(); // String | 
+
+try {
+    final result = await api_instance.deleteService(serviceId);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->deleteService: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-ServiceRegistryAndSupervision-deleteService-204-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-ServiceRegistryAndSupervision-deleteService-schema-204'); + result.empty(); + result.append(view.render()); + }); +

+ +

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String serviceId = new String(); // String | The identity of the service
+
+try {
+    final result = await api_instance.getServices(serviceId);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getServices: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-ServiceRegistryAndSupervision-getServices-200-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-ServiceRegistryAndSupervision-getServices-schema-200'); + result.empty(); + result.append(view.render()); + }); +

+ +

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String serviceId = new String(); // String | 
+
+try {
+    final result = await api_instance.keepAliveService(serviceId);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->keepAliveService: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-ServiceRegistryAndSupervision-keepAliveService-200-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-ServiceRegistryAndSupervision-keepAliveService-schema-200'); + result.empty(); + result.append(view.render()); + }); +

+ +

Curl
Java
Dart
Android
Obj-C

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final ServiceRegistrationInfo serviceRegistrationInfo = new ServiceRegistrationInfo(); // ServiceRegistrationInfo | 
+
+try {
+    final result = await api_instance.putService(serviceRegistrationInfo);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->putService: $e\n');
+}
+

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-ServiceRegistryAndSupervision-putService-200-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-ServiceRegistryAndSupervision-putService-schema-200'); + result.empty(); + result.append(view.render()); + }); +

+ +

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-ServiceRegistryAndSupervision-putService-201-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-ServiceRegistryAndSupervision-putService-schema-201'); + result.empty(); + result.append(view.render()); + }); +

+ +

- -

- + } else if (schema.items != null && schema.items.$ref != null) { + schema.items = defsParser.$refs.get(schema.items.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema, 3); + $('#responses-ServiceRegistryAndSupervision-putService-400-schema-data').val(JSON.stringify(schema)); + var result = $('#responses-ServiceRegistryAndSupervision-putService-schema-400'); + result.empty(); + result.append(view.render()); + }); +

+ +

A1 policy management API

+ +

A1 policy management API

API and SDK Documentation

Version: 1.0.0

General

The O-RAN Non-RT RIC Policy Management Service provides a REST API for managemecnt of A1 policies.
The main tasks of the service are:

A1 Policy creation, modification and deletion.
Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs
Maintaining a view of supported Near-RT RIC policy types
Supervision of using services (R-APPs). When a service is unavailable, its policies are removed.

APIs provided or defined by the service

A1 Policy Management

This is an API for management of A1 Policies.

A1 Policy retrieval, creation, modification and deletion.
Retrieval of supported A1 Policy types for a Near-RT RIC
Retrieval of status for existing A1 policies

Management of configuration

API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.

Service callbacks

These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.

NearRT-RIC Repository

This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted for one Near-RT RIC.

Health Check

API used for supervision of the PMS component.

Service Registry and Supervision

Authorization API

API used for access control of A1 Policy access. If configured, an external authorization provider is requested to grant access to the A1 Policy type.

+ +

A1PolicyManagement

createPolicy

To create A1 policies

+
+

/policies

Usage and SDK Samples

+ +

curl -X POST \
+ -H "Accept: application/json,application/problem+json" \
+ -H "Content-Type: application/json" \
+ "https://example.com/a1-policy-management/v1/policies" \
+ -d '{
+  "policyId" : "POLICY-ID",
+  "nearRtRicId" : "Near-RT-Ric-ID",
+  "transient" : false,
+  "policyObject" : "{}",
+  "serviceId" : "rApp ID",
+  "policyTypeId" : "ORAN_QOS_1.0.0(typeName_SemVersion)"
+}'
+

import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.A1PolicyManagementApi;
+
+import java.io.File;
+import java.util.*;
+
+public class A1PolicyManagementApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
+        PolicyObjectInformation policyObjectInformation = ; // PolicyObjectInformation | 
+
+        try {
+            PolicyObjectInformation result = apiInstance.createPolicy(policyObjectInformation);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling A1PolicyManagementApi#createPolicy");
+            e.printStackTrace();
+        }
+    }
+}
+

+ +

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final PolicyObjectInformation policyObjectInformation = new PolicyObjectInformation(); // PolicyObjectInformation | 
+
+try {
+    final result = await api_instance.createPolicy(policyObjectInformation);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->createPolicy: $e\n');
+}
+
+

+ +

import org.openapitools.client.api.A1PolicyManagementApi;
+
+public class A1PolicyManagementApiExample {
+    public static void main(String[] args) {
+        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
+        PolicyObjectInformation policyObjectInformation = ; // PolicyObjectInformation | 
+
+        try {
+            PolicyObjectInformation result = apiInstance.createPolicy(policyObjectInformation);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling A1PolicyManagementApi#createPolicy");
+            e.printStackTrace();
+        }
+    }
+}

+ +


+
+// Create an instance of the API class
+A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
+PolicyObjectInformation *policyObjectInformation = ; // 
+
+[apiInstance createPolicyWith:policyObjectInformation
+              completionHandler: ^(PolicyObjectInformation output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+

+ +

var A1PolicyManagementApi = require('a1_policy_management_api');
+
+// Create an instance of the API class
+var api = new A1PolicyManagementApi.A1PolicyManagementApi()
+var policyObjectInformation = ; // {PolicyObjectInformation} 
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.createPolicy(policyObjectInformation, callback);
+

+ + +

using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class createPolicyExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new A1PolicyManagementApi();
+            var policyObjectInformation = new PolicyObjectInformation(); // PolicyObjectInformation | 
+
+            try {
+                PolicyObjectInformation result = apiInstance.createPolicy(policyObjectInformation);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling A1PolicyManagementApi.createPolicy: " + e.Message );
+            }
+        }
+    }
+}
+

+ +

<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\A1PolicyManagementApi();
+$policyObjectInformation = ; // PolicyObjectInformation | 
+
+try {
+    $result = $api_instance->createPolicy($policyObjectInformation);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling A1PolicyManagementApi->createPolicy: ', $e->getMessage(), PHP_EOL;
+}
+?>

+ +

use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::A1PolicyManagementApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::A1PolicyManagementApi->new();
+my $policyObjectInformation = WWW::OPenAPIClient::Object::PolicyObjectInformation->new(); # PolicyObjectInformation | 
+
+eval {
+    my $result = $api_instance->createPolicy(policyObjectInformation => $policyObjectInformation);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling A1PolicyManagementApi->createPolicy: $@\n";
+}

+ +

from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.A1PolicyManagementApi()
+policyObjectInformation =  # PolicyObjectInformation | 
+
+try:
+    api_response = api_instance.create_policy(policyObjectInformation)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling A1PolicyManagementApi->createPolicy: %s\n" % e)

+ +

extern crate A1PolicyManagementApi;
+
+pub fn main() {
+    let policyObjectInformation = ; // PolicyObjectInformation
+
+    let mut context = A1PolicyManagementApi::Context::default();
+    let result = client.createPolicy(policyObjectInformation, &context).wait();
+
+    println!("{:?}", result);
+}
+

+ +

Scopes

+ + +

+ +

Parameters

+ + + +

Body parameters

+ + + + + + + + + +

Name	Description
policyObjectInformation *	+ + + +

+ + + +

Responses

+ + + +

+ Schema +
+ Headers +

+ + +

+ +

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

Name	Type	Format	Description
Location	String		Contains the URI of the newly created resource

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

deletePolicy

Delete a policy

Deleting the policy using policyId.

+
+

/policies/{policyId}

Usage and SDK Samples

+ +

curl -X DELETE \
+ -H "Accept: application/problem+json" \
+ "https://example.com/a1-policy-management/v1/policies/{policyId}"
+

import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.A1PolicyManagementApi;
+
+import java.io.File;
+import java.util.*;
+
+public class A1PolicyManagementApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
+        String policyId = policyId_example; // String | 
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            apiInstance.deletePolicy(policyId, accept);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling A1PolicyManagementApi#deletePolicy");
+            e.printStackTrace();
+        }
+    }
+}
+

+ +

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String policyId = new String(); // String | 
+final String accept = new String(); // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    final result = await api_instance.deletePolicy(policyId, accept);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->deletePolicy: $e\n');
+}
+
+

+ +

import org.openapitools.client.api.A1PolicyManagementApi;
+
+public class A1PolicyManagementApiExample {
+    public static void main(String[] args) {
+        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
+        String policyId = policyId_example; // String | 
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            apiInstance.deletePolicy(policyId, accept);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling A1PolicyManagementApi#deletePolicy");
+            e.printStackTrace();
+        }
+    }
+}

+ +


+
+// Create an instance of the API class
+A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
+String *policyId = policyId_example; //  (default to null)
+String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+// Delete a policy
+[apiInstance deletePolicyWith:policyId
+    accept:accept
+              completionHandler: ^(NSError* error) {
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+

+ +

var A1PolicyManagementApi = require('a1_policy_management_api');
+
+// Create an instance of the API class
+var api = new A1PolicyManagementApi.A1PolicyManagementApi()
+var policyId = policyId_example; // {String} 
+var opts = {
+  'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.deletePolicy(policyId, opts, callback);
+

+ + +

using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class deletePolicyExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new A1PolicyManagementApi();
+            var policyId = policyId_example;  // String |  (default to null)
+            var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)
+
+            try {
+                // Delete a policy
+                apiInstance.deletePolicy(policyId, accept);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling A1PolicyManagementApi.deletePolicy: " + e.Message );
+            }
+        }
+    }
+}
+

+ +

<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\A1PolicyManagementApi();
+$policyId = policyId_example; // String | 
+$accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    $api_instance->deletePolicy($policyId, $accept);
+} catch (Exception $e) {
+    echo 'Exception when calling A1PolicyManagementApi->deletePolicy: ', $e->getMessage(), PHP_EOL;
+}
+?>

+ +

use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::A1PolicyManagementApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::A1PolicyManagementApi->new();
+my $policyId = policyId_example; # String | 
+my $accept = application/json; # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+eval {
+    $api_instance->deletePolicy(policyId => $policyId, accept => $accept);
+};
+if ($@) {
+    warn "Exception when calling A1PolicyManagementApi->deletePolicy: $@\n";
+}

+ +

from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.A1PolicyManagementApi()
+policyId = policyId_example # String |  (default to null)
+accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+try:
+    # Delete a policy
+    api_instance.delete_policy(policyId, accept=accept)
+except ApiException as e:
+    print("Exception when calling A1PolicyManagementApi->deletePolicy: %s\n" % e)

+ +

extern crate A1PolicyManagementApi;
+
+pub fn main() {
+    let policyId = policyId_example; // String
+    let accept = application/json; // String
+
+    let mut context = A1PolicyManagementApi::Context::default();
+    let result = client.deletePolicy(policyId, accept, &context).wait();
+
+    println!("{:?}", result);
+}
+

+ +

Scopes

+ + +

+ +

Parameters

+ +

Path parameters

+ + + + + + + + + +

Name	Description
policyId*	+ + + + + + + String + + + + + Required + + + +

+ +

Header parameters

+ + + + + + + + + +

Name	Description
Accept	+ + + + + + + String + + + +Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. + + + + +

+ + + + +

Responses

+ + + +

+ + + + + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

getAllPolicies

Query policy identities

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

+
+

/policies

Usage and SDK Samples

+ +

curl -X GET \
+ -H "Accept: application/json,application/problem+json" \
+ "https://example.com/a1-policy-management/v1/policies?policyTypeId=policyTypeId_example&nearRtRicId=nearRtRicId_example&serviceId=serviceId_example&typeName=typeName_example"
+

import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.A1PolicyManagementApi;
+
+import java.io.File;
+import java.util.*;
+
+public class A1PolicyManagementApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
+        String policyTypeId = policyTypeId_example; // String | Select policies of a given policy type identity.
+        String nearRtRicId = nearRtRicId_example; // String | Select policies of a given Near-RT RIC identity.
+        String serviceId = serviceId_example; // String | Select policies owned by a given service.
+        String typeName = typeName_example; // String | Select policies of types with the given type name (type identity has the format )
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            array[PolicyInformation] result = apiInstance.getAllPolicies(policyTypeId, nearRtRicId, serviceId, typeName, accept);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling A1PolicyManagementApi#getAllPolicies");
+            e.printStackTrace();
+        }
+    }
+}
+

+ +

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String policyTypeId = new String(); // String | Select policies of a given policy type identity.
+final String nearRtRicId = new String(); // String | Select policies of a given Near-RT RIC identity.
+final String serviceId = new String(); // String | Select policies owned by a given service.
+final String typeName = new String(); // String | Select policies of types with the given type name (type identity has the format )
+final String accept = new String(); // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    final result = await api_instance.getAllPolicies(policyTypeId, nearRtRicId, serviceId, typeName, accept);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getAllPolicies: $e\n');
+}
+
+

+ +

import org.openapitools.client.api.A1PolicyManagementApi;
+
+public class A1PolicyManagementApiExample {
+    public static void main(String[] args) {
+        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
+        String policyTypeId = policyTypeId_example; // String | Select policies of a given policy type identity.
+        String nearRtRicId = nearRtRicId_example; // String | Select policies of a given Near-RT RIC identity.
+        String serviceId = serviceId_example; // String | Select policies owned by a given service.
+        String typeName = typeName_example; // String | Select policies of types with the given type name (type identity has the format )
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            array[PolicyInformation] result = apiInstance.getAllPolicies(policyTypeId, nearRtRicId, serviceId, typeName, accept);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling A1PolicyManagementApi#getAllPolicies");
+            e.printStackTrace();
+        }
+    }
+}

+ +


+
+// Create an instance of the API class
+A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
+String *policyTypeId = policyTypeId_example; // Select policies of a given policy type identity. (optional) (default to null)
+String *nearRtRicId = nearRtRicId_example; // Select policies of a given Near-RT RIC identity. (optional) (default to null)
+String *serviceId = serviceId_example; // Select policies owned by a given service. (optional) (default to null)
+String *typeName = typeName_example; // Select policies of types with the given type name (type identity has the format ) (optional) (default to null)
+String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+// Query policy identities
+[apiInstance getAllPoliciesWith:policyTypeId
+    nearRtRicId:nearRtRicId
+    serviceId:serviceId
+    typeName:typeName
+    accept:accept
+              completionHandler: ^(array[PolicyInformation] output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+

+ +

var A1PolicyManagementApi = require('a1_policy_management_api');
+
+// Create an instance of the API class
+var api = new A1PolicyManagementApi.A1PolicyManagementApi()
+var opts = {
+  'policyTypeId': policyTypeId_example, // {String} Select policies of a given policy type identity.
+  'nearRtRicId': nearRtRicId_example, // {String} Select policies of a given Near-RT RIC identity.
+  'serviceId': serviceId_example, // {String} Select policies owned by a given service.
+  'typeName': typeName_example, // {String} Select policies of types with the given type name (type identity has the format )
+  'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getAllPolicies(opts, callback);
+

+ + +

using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class getAllPoliciesExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new A1PolicyManagementApi();
+            var policyTypeId = policyTypeId_example;  // String | Select policies of a given policy type identity. (optional)  (default to null)
+            var nearRtRicId = nearRtRicId_example;  // String | Select policies of a given Near-RT RIC identity. (optional)  (default to null)
+            var serviceId = serviceId_example;  // String | Select policies owned by a given service. (optional)  (default to null)
+            var typeName = typeName_example;  // String | Select policies of types with the given type name (type identity has the format ) (optional)  (default to null)
+            var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)
+
+            try {
+                // Query policy identities
+                array[PolicyInformation] result = apiInstance.getAllPolicies(policyTypeId, nearRtRicId, serviceId, typeName, accept);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling A1PolicyManagementApi.getAllPolicies: " + e.Message );
+            }
+        }
+    }
+}
+

+ +

<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\A1PolicyManagementApi();
+$policyTypeId = policyTypeId_example; // String | Select policies of a given policy type identity.
+$nearRtRicId = nearRtRicId_example; // String | Select policies of a given Near-RT RIC identity.
+$serviceId = serviceId_example; // String | Select policies owned by a given service.
+$typeName = typeName_example; // String | Select policies of types with the given type name (type identity has the format )
+$accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    $result = $api_instance->getAllPolicies($policyTypeId, $nearRtRicId, $serviceId, $typeName, $accept);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling A1PolicyManagementApi->getAllPolicies: ', $e->getMessage(), PHP_EOL;
+}
+?>

+ +

use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::A1PolicyManagementApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::A1PolicyManagementApi->new();
+my $policyTypeId = policyTypeId_example; # String | Select policies of a given policy type identity.
+my $nearRtRicId = nearRtRicId_example; # String | Select policies of a given Near-RT RIC identity.
+my $serviceId = serviceId_example; # String | Select policies owned by a given service.
+my $typeName = typeName_example; # String | Select policies of types with the given type name (type identity has the format )
+my $accept = application/json; # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+eval {
+    my $result = $api_instance->getAllPolicies(policyTypeId => $policyTypeId, nearRtRicId => $nearRtRicId, serviceId => $serviceId, typeName => $typeName, accept => $accept);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling A1PolicyManagementApi->getAllPolicies: $@\n";
+}

+ +

from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.A1PolicyManagementApi()
+policyTypeId = policyTypeId_example # String | Select policies of a given policy type identity. (optional) (default to null)
+nearRtRicId = nearRtRicId_example # String | Select policies of a given Near-RT RIC identity. (optional) (default to null)
+serviceId = serviceId_example # String | Select policies owned by a given service. (optional) (default to null)
+typeName = typeName_example # String | Select policies of types with the given type name (type identity has the format ) (optional) (default to null)
+accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+try:
+    # Query policy identities
+    api_response = api_instance.get_all_policies(policyTypeId=policyTypeId, nearRtRicId=nearRtRicId, serviceId=serviceId, typeName=typeName, accept=accept)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling A1PolicyManagementApi->getAllPolicies: %s\n" % e)

+ +

extern crate A1PolicyManagementApi;
+
+pub fn main() {
+    let policyTypeId = policyTypeId_example; // String
+    let nearRtRicId = nearRtRicId_example; // String
+    let serviceId = serviceId_example; // String
+    let typeName = typeName_example; // String
+    let accept = application/json; // String
+
+    let mut context = A1PolicyManagementApi::Context::default();
+    let result = client.getAllPolicies(policyTypeId, nearRtRicId, serviceId, typeName, accept, &context).wait();
+
+    println!("{:?}", result);
+}
+

+ +

Scopes

+ + +

+ +

Parameters

+ + +

Header parameters

+ + + + + + + + + +

Name	Description
Accept	+ + + + + + + String + + + +Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. + + + + +

+ + + +

Query parameters

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

Name	Description
policyTypeId	+ + + + + + + String + + + +Select policies of a given policy type identity. + + + + +
nearRtRicId	+ + + + + + + String + + + +Select policies of a given Near-RT RIC identity. + + + + +
serviceId	+ + + + + + + String + + + +Select policies owned by a given service. + + + + +
typeName	+ + + + + + + String + + + +Select policies of types with the given type name (type identity has the format <typename_version>) + + + + +

+ +

Responses

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

getPolicy

Returns a policy

+
+

/policies/{policyId}

Usage and SDK Samples

+ +

curl -X GET \
+ -H "Accept: application/json,application/problem+json" \
+ "https://example.com/a1-policy-management/v1/policies/{policyId}"
+

import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.A1PolicyManagementApi;
+
+import java.io.File;
+import java.util.*;
+
+public class A1PolicyManagementApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
+        String policyId = policyId_example; // String | 
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            Object result = apiInstance.getPolicy(policyId, accept);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling A1PolicyManagementApi#getPolicy");
+            e.printStackTrace();
+        }
+    }
+}
+

+ +

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String policyId = new String(); // String | 
+final String accept = new String(); // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    final result = await api_instance.getPolicy(policyId, accept);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getPolicy: $e\n');
+}
+
+

+ +

import org.openapitools.client.api.A1PolicyManagementApi;
+
+public class A1PolicyManagementApiExample {
+    public static void main(String[] args) {
+        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
+        String policyId = policyId_example; // String | 
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            Object result = apiInstance.getPolicy(policyId, accept);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling A1PolicyManagementApi#getPolicy");
+            e.printStackTrace();
+        }
+    }
+}

+ +


+
+// Create an instance of the API class
+A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
+String *policyId = policyId_example; //  (default to null)
+String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+[apiInstance getPolicyWith:policyId
+    accept:accept
+              completionHandler: ^(Object output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+

+ +

var A1PolicyManagementApi = require('a1_policy_management_api');
+
+// Create an instance of the API class
+var api = new A1PolicyManagementApi.A1PolicyManagementApi()
+var policyId = policyId_example; // {String} 
+var opts = {
+  'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getPolicy(policyId, opts, callback);
+

+ + +

using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class getPolicyExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new A1PolicyManagementApi();
+            var policyId = policyId_example;  // String |  (default to null)
+            var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)
+
+            try {
+                Object result = apiInstance.getPolicy(policyId, accept);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling A1PolicyManagementApi.getPolicy: " + e.Message );
+            }
+        }
+    }
+}
+

+ +

<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\A1PolicyManagementApi();
+$policyId = policyId_example; // String | 
+$accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    $result = $api_instance->getPolicy($policyId, $accept);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling A1PolicyManagementApi->getPolicy: ', $e->getMessage(), PHP_EOL;
+}
+?>

+ +

use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::A1PolicyManagementApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::A1PolicyManagementApi->new();
+my $policyId = policyId_example; # String | 
+my $accept = application/json; # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+eval {
+    my $result = $api_instance->getPolicy(policyId => $policyId, accept => $accept);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling A1PolicyManagementApi->getPolicy: $@\n";
+}

+ +

from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.A1PolicyManagementApi()
+policyId = policyId_example # String |  (default to null)
+accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+try:
+    api_response = api_instance.get_policy(policyId, accept=accept)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling A1PolicyManagementApi->getPolicy: %s\n" % e)

+ +

extern crate A1PolicyManagementApi;
+
+pub fn main() {
+    let policyId = policyId_example; // String
+    let accept = application/json; // String
+
+    let mut context = A1PolicyManagementApi::Context::default();
+    let result = client.getPolicy(policyId, accept, &context).wait();
+
+    println!("{:?}", result);
+}
+

+ +

Scopes

+ + +

+ +

Parameters

+ +

Path parameters

+ + + + + + + + + +

Name	Description
policyId*	+ + + + + + + String + + + + + Required + + + +

+ +

Header parameters

+ + + + + + + + + +

Name	Description
Accept	+ + + + + + + String + + + +Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. + + + + +

+ + + + +

Responses

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

getPolicyTypeDefinition

Returns a policy type definition

+
+

/policy-types/{policyTypeId}

Usage and SDK Samples

+ +

curl -X GET \
+ -H "Accept: application/json,application/problem+json" \
+ "https://example.com/a1-policy-management/v1/policy-types/{policyTypeId}"
+

import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.A1PolicyManagementApi;
+
+import java.io.File;
+import java.util.*;
+
+public class A1PolicyManagementApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
+        String policyTypeId = policyTypeId_example; // String | 
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            Object result = apiInstance.getPolicyTypeDefinition(policyTypeId, accept);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling A1PolicyManagementApi#getPolicyTypeDefinition");
+            e.printStackTrace();
+        }
+    }
+}
+

+ +

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String policyTypeId = new String(); // String | 
+final String accept = new String(); // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    final result = await api_instance.getPolicyTypeDefinition(policyTypeId, accept);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getPolicyTypeDefinition: $e\n');
+}
+
+

+ +

import org.openapitools.client.api.A1PolicyManagementApi;
+
+public class A1PolicyManagementApiExample {
+    public static void main(String[] args) {
+        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
+        String policyTypeId = policyTypeId_example; // String | 
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            Object result = apiInstance.getPolicyTypeDefinition(policyTypeId, accept);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling A1PolicyManagementApi#getPolicyTypeDefinition");
+            e.printStackTrace();
+        }
+    }
+}

+ +


+
+// Create an instance of the API class
+A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
+String *policyTypeId = policyTypeId_example; //  (default to null)
+String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+[apiInstance getPolicyTypeDefinitionWith:policyTypeId
+    accept:accept
+              completionHandler: ^(Object output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+

+ +

var A1PolicyManagementApi = require('a1_policy_management_api');
+
+// Create an instance of the API class
+var api = new A1PolicyManagementApi.A1PolicyManagementApi()
+var policyTypeId = policyTypeId_example; // {String} 
+var opts = {
+  'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getPolicyTypeDefinition(policyTypeId, opts, callback);
+

+ + +

using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class getPolicyTypeDefinitionExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new A1PolicyManagementApi();
+            var policyTypeId = policyTypeId_example;  // String |  (default to null)
+            var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)
+
+            try {
+                Object result = apiInstance.getPolicyTypeDefinition(policyTypeId, accept);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling A1PolicyManagementApi.getPolicyTypeDefinition: " + e.Message );
+            }
+        }
+    }
+}
+

+ +

<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\A1PolicyManagementApi();
+$policyTypeId = policyTypeId_example; // String | 
+$accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    $result = $api_instance->getPolicyTypeDefinition($policyTypeId, $accept);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling A1PolicyManagementApi->getPolicyTypeDefinition: ', $e->getMessage(), PHP_EOL;
+}
+?>

+ +

use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::A1PolicyManagementApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::A1PolicyManagementApi->new();
+my $policyTypeId = policyTypeId_example; # String | 
+my $accept = application/json; # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+eval {
+    my $result = $api_instance->getPolicyTypeDefinition(policyTypeId => $policyTypeId, accept => $accept);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling A1PolicyManagementApi->getPolicyTypeDefinition: $@\n";
+}

+ +

from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.A1PolicyManagementApi()
+policyTypeId = policyTypeId_example # String |  (default to null)
+accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+try:
+    api_response = api_instance.get_policy_type_definition(policyTypeId, accept=accept)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling A1PolicyManagementApi->getPolicyTypeDefinition: %s\n" % e)

+ +

extern crate A1PolicyManagementApi;
+
+pub fn main() {
+    let policyTypeId = policyTypeId_example; // String
+    let accept = application/json; // String
+
+    let mut context = A1PolicyManagementApi::Context::default();
+    let result = client.getPolicyTypeDefinition(policyTypeId, accept, &context).wait();
+
+    println!("{:?}", result);
+}
+

+ +

Scopes

+ + +

+ +

Parameters

+ +

Path parameters

+ + + + + + + + + +

Name	Description
policyTypeId*	+ + + + + + + String + + + + + Required + + + +

+ +

Header parameters

+ + + + + + + + + +

Name	Description
Accept	+ + + + + + + String + + + +Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. + + + + +

+ + + + +

Responses

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

getPolicyTypes

Query policy type identities

+
+

/policy-types

Usage and SDK Samples

+ +

curl -X GET \
+ -H "Accept: application/json,application/problem+json" \
+ "https://example.com/a1-policy-management/v1/policy-types?nearRtRicId=nearRtRicId_example&typeName=typeName_example&compatibleWithVersion=compatibleWithVersion_example"
+

import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.A1PolicyManagementApi;
+
+import java.io.File;
+import java.util.*;
+
+public class A1PolicyManagementApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
+        String nearRtRicId = nearRtRicId_example; // String | Select types for the given Near-RT RIC identity.
+        String typeName = typeName_example; // String | Select types with the given type name (type identity has the format )
+        String compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order.
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            array[PolicyTypeInformation] result = apiInstance.getPolicyTypes(nearRtRicId, typeName, compatibleWithVersion, accept);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling A1PolicyManagementApi#getPolicyTypes");
+            e.printStackTrace();
+        }
+    }
+}
+

+ +

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String nearRtRicId = new String(); // String | Select types for the given Near-RT RIC identity.
+final String typeName = new String(); // String | Select types with the given type name (type identity has the format )
+final String compatibleWithVersion = new String(); // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order.
+final String accept = new String(); // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    final result = await api_instance.getPolicyTypes(nearRtRicId, typeName, compatibleWithVersion, accept);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getPolicyTypes: $e\n');
+}
+
+

+ +

import org.openapitools.client.api.A1PolicyManagementApi;
+
+public class A1PolicyManagementApiExample {
+    public static void main(String[] args) {
+        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
+        String nearRtRicId = nearRtRicId_example; // String | Select types for the given Near-RT RIC identity.
+        String typeName = typeName_example; // String | Select types with the given type name (type identity has the format )
+        String compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order.
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            array[PolicyTypeInformation] result = apiInstance.getPolicyTypes(nearRtRicId, typeName, compatibleWithVersion, accept);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling A1PolicyManagementApi#getPolicyTypes");
+            e.printStackTrace();
+        }
+    }
+}

+ +


+
+// Create an instance of the API class
+A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
+String *nearRtRicId = nearRtRicId_example; // Select types for the given Near-RT RIC identity. (optional) (default to null)
+String *typeName = typeName_example; // Select types with the given type name (type identity has the format ) (optional) (default to null)
+String *compatibleWithVersion = compatibleWithVersion_example; // Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. (optional) (default to null)
+String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+[apiInstance getPolicyTypesWith:nearRtRicId
+    typeName:typeName
+    compatibleWithVersion:compatibleWithVersion
+    accept:accept
+              completionHandler: ^(array[PolicyTypeInformation] output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+

+ +

var A1PolicyManagementApi = require('a1_policy_management_api');
+
+// Create an instance of the API class
+var api = new A1PolicyManagementApi.A1PolicyManagementApi()
+var opts = {
+  'nearRtRicId': nearRtRicId_example, // {String} Select types for the given Near-RT RIC identity.
+  'typeName': typeName_example, // {String} Select types with the given type name (type identity has the format )
+  'compatibleWithVersion': compatibleWithVersion_example, // {String} Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order.
+  'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getPolicyTypes(opts, callback);
+

+ + +

using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class getPolicyTypesExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new A1PolicyManagementApi();
+            var nearRtRicId = nearRtRicId_example;  // String | Select types for the given Near-RT RIC identity. (optional)  (default to null)
+            var typeName = typeName_example;  // String | Select types with the given type name (type identity has the format ) (optional)  (default to null)
+            var compatibleWithVersion = compatibleWithVersion_example;  // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. (optional)  (default to null)
+            var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)
+
+            try {
+                array[PolicyTypeInformation] result = apiInstance.getPolicyTypes(nearRtRicId, typeName, compatibleWithVersion, accept);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling A1PolicyManagementApi.getPolicyTypes: " + e.Message );
+            }
+        }
+    }
+}
+

+ +

<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\A1PolicyManagementApi();
+$nearRtRicId = nearRtRicId_example; // String | Select types for the given Near-RT RIC identity.
+$typeName = typeName_example; // String | Select types with the given type name (type identity has the format )
+$compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order.
+$accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    $result = $api_instance->getPolicyTypes($nearRtRicId, $typeName, $compatibleWithVersion, $accept);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling A1PolicyManagementApi->getPolicyTypes: ', $e->getMessage(), PHP_EOL;
+}
+?>

+ +

use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::A1PolicyManagementApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::A1PolicyManagementApi->new();
+my $nearRtRicId = nearRtRicId_example; # String | Select types for the given Near-RT RIC identity.
+my $typeName = typeName_example; # String | Select types with the given type name (type identity has the format )
+my $compatibleWithVersion = compatibleWithVersion_example; # String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order.
+my $accept = application/json; # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+eval {
+    my $result = $api_instance->getPolicyTypes(nearRtRicId => $nearRtRicId, typeName => $typeName, compatibleWithVersion => $compatibleWithVersion, accept => $accept);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling A1PolicyManagementApi->getPolicyTypes: $@\n";
+}

+ +

from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.A1PolicyManagementApi()
+nearRtRicId = nearRtRicId_example # String | Select types for the given Near-RT RIC identity. (optional) (default to null)
+typeName = typeName_example # String | Select types with the given type name (type identity has the format ) (optional) (default to null)
+compatibleWithVersion = compatibleWithVersion_example # String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. (optional) (default to null)
+accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+try:
+    api_response = api_instance.get_policy_types(nearRtRicId=nearRtRicId, typeName=typeName, compatibleWithVersion=compatibleWithVersion, accept=accept)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling A1PolicyManagementApi->getPolicyTypes: %s\n" % e)

+ +

extern crate A1PolicyManagementApi;
+
+pub fn main() {
+    let nearRtRicId = nearRtRicId_example; // String
+    let typeName = typeName_example; // String
+    let compatibleWithVersion = compatibleWithVersion_example; // String
+    let accept = application/json; // String
+
+    let mut context = A1PolicyManagementApi::Context::default();
+    let result = client.getPolicyTypes(nearRtRicId, typeName, compatibleWithVersion, accept, &context).wait();
+
+    println!("{:?}", result);
+}
+

+ +

Scopes

+ + +

+ +

Parameters

+ + +

Header parameters

+ + + + + + + + + +

Name	Description
Accept	+ + + + + + + String + + + +Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. + + + + +

+ + + +

Query parameters

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

Name	Description
nearRtRicId	+ + + + + + + String + + + +Select types for the given Near-RT RIC identity. + + + + +
typeName	+ + + + + + + String + + + +Select types with the given type name (type identity has the format <typename_version>) + + + + +
compatibleWithVersion	+ + + + + + + String + + + +Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + + + + +

+ +

Responses

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

putPolicy

update a policy

+
+

/policies/{policyId}

Usage and SDK Samples

+ +

curl -X PUT \
+ -H "Accept: application/json,application/problem+json" \
+ -H "Content-Type: application/json" \
+ "https://example.com/a1-policy-management/v1/policies/{policyId}" \
+ -d ''
+

import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.A1PolicyManagementApi;
+
+import java.io.File;
+import java.util.*;
+
+public class A1PolicyManagementApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
+        String policyId = policyId_example; // String | 
+        Object body = Object; // Object | 
+
+        try {
+            Object result = apiInstance.putPolicy(policyId, body);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling A1PolicyManagementApi#putPolicy");
+            e.printStackTrace();
+        }
+    }
+}
+

+ +

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String policyId = new String(); // String | 
+final Object body = new Object(); // Object | 
+
+try {
+    final result = await api_instance.putPolicy(policyId, body);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->putPolicy: $e\n');
+}
+
+

+ +

import org.openapitools.client.api.A1PolicyManagementApi;
+
+public class A1PolicyManagementApiExample {
+    public static void main(String[] args) {
+        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
+        String policyId = policyId_example; // String | 
+        Object body = Object; // Object | 
+
+        try {
+            Object result = apiInstance.putPolicy(policyId, body);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling A1PolicyManagementApi#putPolicy");
+            e.printStackTrace();
+        }
+    }
+}

+ +


+
+// Create an instance of the API class
+A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
+String *policyId = policyId_example; //  (default to null)
+Object *body = Object; // 
+
+[apiInstance putPolicyWith:policyId
+    body:body
+              completionHandler: ^(Object output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+

+ +

var A1PolicyManagementApi = require('a1_policy_management_api');
+
+// Create an instance of the API class
+var api = new A1PolicyManagementApi.A1PolicyManagementApi()
+var policyId = policyId_example; // {String} 
+var body = Object; // {Object} 
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.putPolicy(policyId, body, callback);
+

+ + +

using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class putPolicyExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new A1PolicyManagementApi();
+            var policyId = policyId_example;  // String |  (default to null)
+            var body = Object;  // Object | 
+
+            try {
+                Object result = apiInstance.putPolicy(policyId, body);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling A1PolicyManagementApi.putPolicy: " + e.Message );
+            }
+        }
+    }
+}
+

+ +

<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\A1PolicyManagementApi();
+$policyId = policyId_example; // String | 
+$body = Object; // Object | 
+
+try {
+    $result = $api_instance->putPolicy($policyId, $body);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling A1PolicyManagementApi->putPolicy: ', $e->getMessage(), PHP_EOL;
+}
+?>

+ +

use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::A1PolicyManagementApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::A1PolicyManagementApi->new();
+my $policyId = policyId_example; # String | 
+my $body = WWW::OPenAPIClient::Object::Object->new(); # Object | 
+
+eval {
+    my $result = $api_instance->putPolicy(policyId => $policyId, body => $body);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling A1PolicyManagementApi->putPolicy: $@\n";
+}

+ +

from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.A1PolicyManagementApi()
+policyId = policyId_example # String |  (default to null)
+body = Object # Object | 
+
+try:
+    api_response = api_instance.put_policy(policyId, body)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling A1PolicyManagementApi->putPolicy: %s\n" % e)

+ +

extern crate A1PolicyManagementApi;
+
+pub fn main() {
+    let policyId = policyId_example; // String
+    let body = Object; // Object
+
+    let mut context = A1PolicyManagementApi::Context::default();
+    let result = client.putPolicy(policyId, body, &context).wait();
+
+    println!("{:?}", result);
+}
+

+ +

Scopes

+ + +

+ +

Parameters

+ +

Path parameters

+ + + + + + + + + +

Name	Description
policyId*	+ + + + + + + String + + + + + Required + + + +

+ + +

Body parameters

+ + + + + + + + + +

Name	Description
body *	+ + + +

+ + + +

Responses

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

Configuration

getConfiguration

Returns the contents of the application configuration

+
+

/configuration

Usage and SDK Samples

+ +

curl -X GET \
+ -H "Accept: application/json,application/problem+json" \
+ "https://example.com/a1-policy-management/v1/configuration"
+

import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.ConfigurationApi;
+
+import java.io.File;
+import java.util.*;
+
+public class ConfigurationApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        ConfigurationApi apiInstance = new ConfigurationApi();
+
+        try {
+            'String' result = apiInstance.getConfiguration();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling ConfigurationApi#getConfiguration");
+            e.printStackTrace();
+        }
+    }
+}
+

+ +

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+
+try {
+    final result = await api_instance.getConfiguration();
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getConfiguration: $e\n');
+}
+
+

+ +

import org.openapitools.client.api.ConfigurationApi;
+
+public class ConfigurationApiExample {
+    public static void main(String[] args) {
+        ConfigurationApi apiInstance = new ConfigurationApi();
+
+        try {
+            'String' result = apiInstance.getConfiguration();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling ConfigurationApi#getConfiguration");
+            e.printStackTrace();
+        }
+    }
+}

+ +


+
+// Create an instance of the API class
+ConfigurationApi *apiInstance = [[ConfigurationApi alloc] init];
+
+[apiInstance getConfigurationWithCompletionHandler: 
+              ^('String' output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+

+ +

var A1PolicyManagementApi = require('a1_policy_management_api');
+
+// Create an instance of the API class
+var api = new A1PolicyManagementApi.ConfigurationApi()
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getConfiguration(callback);
+

+ + +

using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class getConfigurationExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new ConfigurationApi();
+
+            try {
+                'String' result = apiInstance.getConfiguration();
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling ConfigurationApi.getConfiguration: " + e.Message );
+            }
+        }
+    }
+}
+

+ +

<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\ConfigurationApi();
+
+try {
+    $result = $api_instance->getConfiguration();
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling ConfigurationApi->getConfiguration: ', $e->getMessage(), PHP_EOL;
+}
+?>

+ +

use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::ConfigurationApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::ConfigurationApi->new();
+
+eval {
+    my $result = $api_instance->getConfiguration();
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling ConfigurationApi->getConfiguration: $@\n";
+}

+ +

from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.ConfigurationApi()
+
+try:
+    api_response = api_instance.get_configuration()
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling ConfigurationApi->getConfiguration: %s\n" % e)

+ +

extern crate ConfigurationApi;
+
+pub fn main() {
+
+    let mut context = ConfigurationApi::Context::default();
+    let result = client.getConfiguration(&context).wait();
+
+    println!("{:?}", result);
+}
+

+ +

Scopes

+ + +

+ +

Parameters

+ + + + + + +

Responses

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

putConfiguration

Replace the current configuration file with the given configuration

+
+

/configuration

Usage and SDK Samples

+ +

curl -X PUT \
+ -H "Accept: */*,application/problem+json" \
+ -H "Content-Type: application/json" \
+ "https://example.com/a1-policy-management/v1/configuration" \
+ -d ''
+

import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.ConfigurationApi;
+
+import java.io.File;
+import java.util.*;
+
+public class ConfigurationApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        ConfigurationApi apiInstance = new ConfigurationApi();
+        Object body = Object; // Object | 
+
+        try {
+            Object result = apiInstance.putConfiguration(body);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling ConfigurationApi#putConfiguration");
+            e.printStackTrace();
+        }
+    }
+}
+

+ +

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final Object body = new Object(); // Object | 
+
+try {
+    final result = await api_instance.putConfiguration(body);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->putConfiguration: $e\n');
+}
+
+

+ +

import org.openapitools.client.api.ConfigurationApi;
+
+public class ConfigurationApiExample {
+    public static void main(String[] args) {
+        ConfigurationApi apiInstance = new ConfigurationApi();
+        Object body = Object; // Object | 
+
+        try {
+            Object result = apiInstance.putConfiguration(body);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling ConfigurationApi#putConfiguration");
+            e.printStackTrace();
+        }
+    }
+}

+ +


+
+// Create an instance of the API class
+ConfigurationApi *apiInstance = [[ConfigurationApi alloc] init];
+Object *body = Object; // 
+
+[apiInstance putConfigurationWith:body
+              completionHandler: ^(Object output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+

+ +

var A1PolicyManagementApi = require('a1_policy_management_api');
+
+// Create an instance of the API class
+var api = new A1PolicyManagementApi.ConfigurationApi()
+var body = Object; // {Object} 
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.putConfiguration(body, callback);
+

+ + +

using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class putConfigurationExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new ConfigurationApi();
+            var body = Object;  // Object | 
+
+            try {
+                Object result = apiInstance.putConfiguration(body);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling ConfigurationApi.putConfiguration: " + e.Message );
+            }
+        }
+    }
+}
+

+ +

<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\ConfigurationApi();
+$body = Object; // Object | 
+
+try {
+    $result = $api_instance->putConfiguration($body);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling ConfigurationApi->putConfiguration: ', $e->getMessage(), PHP_EOL;
+}
+?>

+ +

use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::ConfigurationApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::ConfigurationApi->new();
+my $body = WWW::OPenAPIClient::Object::Object->new(); # Object | 
+
+eval {
+    my $result = $api_instance->putConfiguration(body => $body);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling ConfigurationApi->putConfiguration: $@\n";
+}

+ +

from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.ConfigurationApi()
+body = Object # Object | 
+
+try:
+    api_response = api_instance.put_configuration(body)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling ConfigurationApi->putConfiguration: %s\n" % e)

+ +

extern crate ConfigurationApi;
+
+pub fn main() {
+    let body = Object; // Object
+
+    let mut context = ConfigurationApi::Context::default();
+    let result = client.putConfiguration(body, &context).wait();
+
+    println!("{:?}", result);
+}
+

+ +

Scopes

+ + +

+ +

Parameters

+ + + +

Body parameters

+ + + + + + + + + +

Name	Description
body *	+ + + +

+ + + +

Responses

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

HealthCheck

getStatus

Returns status and statistics of this service

+
+

/status

Usage and SDK Samples

+ +

curl -X GET \
+ -H "Accept: application/json" \
+ "https://example.com/a1-policy-management/v1/status"
+

import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.HealthCheckApi;
+
+import java.io.File;
+import java.util.*;
+
+public class HealthCheckApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        HealthCheckApi apiInstance = new HealthCheckApi();
+
+        try {
+            StatusInfo result = apiInstance.getStatus();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling HealthCheckApi#getStatus");
+            e.printStackTrace();
+        }
+    }
+}
+

+ +

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+
+try {
+    final result = await api_instance.getStatus();
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getStatus: $e\n');
+}
+
+

+ +

import org.openapitools.client.api.HealthCheckApi;
+
+public class HealthCheckApiExample {
+    public static void main(String[] args) {
+        HealthCheckApi apiInstance = new HealthCheckApi();
+
+        try {
+            StatusInfo result = apiInstance.getStatus();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling HealthCheckApi#getStatus");
+            e.printStackTrace();
+        }
+    }
+}

+ +


+
+// Create an instance of the API class
+HealthCheckApi *apiInstance = [[HealthCheckApi alloc] init];
+
+[apiInstance getStatusWithCompletionHandler: 
+              ^(StatusInfo output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+

+ +

var A1PolicyManagementApi = require('a1_policy_management_api');
+
+// Create an instance of the API class
+var api = new A1PolicyManagementApi.HealthCheckApi()
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getStatus(callback);
+

+ + +

using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class getStatusExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new HealthCheckApi();
+
+            try {
+                StatusInfo result = apiInstance.getStatus();
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling HealthCheckApi.getStatus: " + e.Message );
+            }
+        }
+    }
+}
+

+ +

<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\HealthCheckApi();
+
+try {
+    $result = $api_instance->getStatus();
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling HealthCheckApi->getStatus: ', $e->getMessage(), PHP_EOL;
+}
+?>

+ +

use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::HealthCheckApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::HealthCheckApi->new();
+
+eval {
+    my $result = $api_instance->getStatus();
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling HealthCheckApi->getStatus: $@\n";
+}

+ +

from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.HealthCheckApi()
+
+try:
+    api_response = api_instance.get_status()
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling HealthCheckApi->getStatus: %s\n" % e)

+ +

extern crate HealthCheckApi;
+
+pub fn main() {
+
+    let mut context = HealthCheckApi::Context::default();
+    let result = client.getStatus(&context).wait();
+
+    println!("{:?}", result);
+}
+

+ +

Scopes

+ + +

+ +

Parameters

+ + + + + + +

Responses

+ + + +

+ Schema +

+ + +

+ +

NearRTRICRepository

getRic

Returns info for one Near-RT RIC

+
+

/rics/ric

Usage and SDK Samples

+ +

curl -X GET \
+ -H "Accept: application/json,application/problem+json" \
+ "https://example.com/a1-policy-management/v1/rics/ric?managedElementId=managedElementId_example&ricId=ricId_example"
+

import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.NearRTRICRepositoryApi;
+
+import java.io.File;
+import java.util.*;
+
+public class NearRTRICRepositoryApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        NearRTRICRepositoryApi apiInstance = new NearRTRICRepositoryApi();
+        String managedElementId = managedElementId_example; // String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
+        String ricId = ricId_example; // String | The identity of a Near-RT RIC to get information for.
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            RicInfo result = apiInstance.getRic(managedElementId, ricId, accept);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling NearRTRICRepositoryApi#getRic");
+            e.printStackTrace();
+        }
+    }
+}
+

+ +

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String managedElementId = new String(); // String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
+final String ricId = new String(); // String | The identity of a Near-RT RIC to get information for.
+final String accept = new String(); // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    final result = await api_instance.getRic(managedElementId, ricId, accept);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getRic: $e\n');
+}
+
+

+ +

import org.openapitools.client.api.NearRTRICRepositoryApi;
+
+public class NearRTRICRepositoryApiExample {
+    public static void main(String[] args) {
+        NearRTRICRepositoryApi apiInstance = new NearRTRICRepositoryApi();
+        String managedElementId = managedElementId_example; // String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
+        String ricId = ricId_example; // String | The identity of a Near-RT RIC to get information for.
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            RicInfo result = apiInstance.getRic(managedElementId, ricId, accept);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling NearRTRICRepositoryApi#getRic");
+            e.printStackTrace();
+        }
+    }
+}

+ +


+
+// Create an instance of the API class
+NearRTRICRepositoryApi *apiInstance = [[NearRTRICRepositoryApi alloc] init];
+String *managedElementId = managedElementId_example; // The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned. (optional) (default to null)
+String *ricId = ricId_example; // The identity of a Near-RT RIC to get information for. (optional) (default to null)
+String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+// Returns info for one Near-RT RIC
+[apiInstance getRicWith:managedElementId
+    ricId:ricId
+    accept:accept
+              completionHandler: ^(RicInfo output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+

+ +

var A1PolicyManagementApi = require('a1_policy_management_api');
+
+// Create an instance of the API class
+var api = new A1PolicyManagementApi.NearRTRICRepositoryApi()
+var opts = {
+  'managedElementId': managedElementId_example, // {String} The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
+  'ricId': ricId_example, // {String} The identity of a Near-RT RIC to get information for.
+  'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getRic(opts, callback);
+

+ + +

using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class getRicExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new NearRTRICRepositoryApi();
+            var managedElementId = managedElementId_example;  // String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned. (optional)  (default to null)
+            var ricId = ricId_example;  // String | The identity of a Near-RT RIC to get information for. (optional)  (default to null)
+            var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)
+
+            try {
+                // Returns info for one Near-RT RIC
+                RicInfo result = apiInstance.getRic(managedElementId, ricId, accept);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling NearRTRICRepositoryApi.getRic: " + e.Message );
+            }
+        }
+    }
+}
+

+ +

<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\NearRTRICRepositoryApi();
+$managedElementId = managedElementId_example; // String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
+$ricId = ricId_example; // String | The identity of a Near-RT RIC to get information for.
+$accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    $result = $api_instance->getRic($managedElementId, $ricId, $accept);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling NearRTRICRepositoryApi->getRic: ', $e->getMessage(), PHP_EOL;
+}
+?>

+ +

use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::NearRTRICRepositoryApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::NearRTRICRepositoryApi->new();
+my $managedElementId = managedElementId_example; # String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
+my $ricId = ricId_example; # String | The identity of a Near-RT RIC to get information for.
+my $accept = application/json; # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+eval {
+    my $result = $api_instance->getRic(managedElementId => $managedElementId, ricId => $ricId, accept => $accept);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling NearRTRICRepositoryApi->getRic: $@\n";
+}

+ +

from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.NearRTRICRepositoryApi()
+managedElementId = managedElementId_example # String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned. (optional) (default to null)
+ricId = ricId_example # String | The identity of a Near-RT RIC to get information for. (optional) (default to null)
+accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+try:
+    # Returns info for one Near-RT RIC
+    api_response = api_instance.get_ric(managedElementId=managedElementId, ricId=ricId, accept=accept)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling NearRTRICRepositoryApi->getRic: %s\n" % e)

+ +

extern crate NearRTRICRepositoryApi;
+
+pub fn main() {
+    let managedElementId = managedElementId_example; // String
+    let ricId = ricId_example; // String
+    let accept = application/json; // String
+
+    let mut context = NearRTRICRepositoryApi::Context::default();
+    let result = client.getRic(managedElementId, ricId, accept, &context).wait();
+
+    println!("{:?}", result);
+}
+

+ +

Scopes

+ + +

+ +

Parameters

+ + +

Header parameters

+ + + + + + + + + +

Name	Description
Accept	+ + + + + + + String + + + +Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. + + + + +

+ + + +

Query parameters

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

Name	Description
managedElementId	+ + + + + + + String + + + +The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned. + + + + +
ricId	+ + + + + + + String + + + +The identity of a Near-RT RIC to get information for. + + + + +

+ +

Responses

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

getRics

Query Near-RT RIC information

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

+
+

/rics

Usage and SDK Samples

+ +

curl -X GET \
+ -H "Accept: application/json,application/problem+json" \
+ "https://example.com/a1-policy-management/v1/rics?policyTypeId=policyTypeId_example"
+

import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.NearRTRICRepositoryApi;
+
+import java.io.File;
+import java.util.*;
+
+public class NearRTRICRepositoryApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        NearRTRICRepositoryApi apiInstance = new NearRTRICRepositoryApi();
+        String policyTypeId = policyTypeId_example; // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            RicInfoList result = apiInstance.getRics(policyTypeId, accept);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling NearRTRICRepositoryApi#getRics");
+            e.printStackTrace();
+        }
+    }
+}
+

+ +

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String policyTypeId = new String(); // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
+final String accept = new String(); // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    final result = await api_instance.getRics(policyTypeId, accept);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getRics: $e\n');
+}
+
+

+ +

import org.openapitools.client.api.NearRTRICRepositoryApi;
+
+public class NearRTRICRepositoryApiExample {
+    public static void main(String[] args) {
+        NearRTRICRepositoryApi apiInstance = new NearRTRICRepositoryApi();
+        String policyTypeId = policyTypeId_example; // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            RicInfoList result = apiInstance.getRics(policyTypeId, accept);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling NearRTRICRepositoryApi#getRics");
+            e.printStackTrace();
+        }
+    }
+}

+ +


+
+// Create an instance of the API class
+NearRTRICRepositoryApi *apiInstance = [[NearRTRICRepositoryApi alloc] init];
+String *policyTypeId = policyTypeId_example; // The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned (optional) (default to null)
+String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+// Query Near-RT RIC information
+[apiInstance getRicsWith:policyTypeId
+    accept:accept
+              completionHandler: ^(RicInfoList output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+

+ +

var A1PolicyManagementApi = require('a1_policy_management_api');
+
+// Create an instance of the API class
+var api = new A1PolicyManagementApi.NearRTRICRepositoryApi()
+var opts = {
+  'policyTypeId': policyTypeId_example, // {String} The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
+  'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getRics(opts, callback);
+

+ + +

using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class getRicsExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new NearRTRICRepositoryApi();
+            var policyTypeId = policyTypeId_example;  // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned (optional)  (default to null)
+            var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)
+
+            try {
+                // Query Near-RT RIC information
+                RicInfoList result = apiInstance.getRics(policyTypeId, accept);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling NearRTRICRepositoryApi.getRics: " + e.Message );
+            }
+        }
+    }
+}
+

+ +

<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\NearRTRICRepositoryApi();
+$policyTypeId = policyTypeId_example; // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
+$accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    $result = $api_instance->getRics($policyTypeId, $accept);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling NearRTRICRepositoryApi->getRics: ', $e->getMessage(), PHP_EOL;
+}
+?>

+ +

use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::NearRTRICRepositoryApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::NearRTRICRepositoryApi->new();
+my $policyTypeId = policyTypeId_example; # String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned
+my $accept = application/json; # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+eval {
+    my $result = $api_instance->getRics(policyTypeId => $policyTypeId, accept => $accept);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling NearRTRICRepositoryApi->getRics: $@\n";
+}

+ +

from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.NearRTRICRepositoryApi()
+policyTypeId = policyTypeId_example # String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned (optional) (default to null)
+accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+try:
+    # Query Near-RT RIC information
+    api_response = api_instance.get_rics(policyTypeId=policyTypeId, accept=accept)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling NearRTRICRepositoryApi->getRics: %s\n" % e)

+ +

extern crate NearRTRICRepositoryApi;
+
+pub fn main() {
+    let policyTypeId = policyTypeId_example; // String
+    let accept = application/json; // String
+
+    let mut context = NearRTRICRepositoryApi::Context::default();
+    let result = client.getRics(policyTypeId, accept, &context).wait();
+
+    println!("{:?}", result);
+}
+

+ +

Scopes

+ + +

+ +

Parameters

+ + +

Header parameters

+ + + + + + + + + +

Name	Description
Accept	+ + + + + + + String + + + +Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. + + + + +

+ + + +

Query parameters

+ + + + + + + + + +

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

+ +

Responses

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

ServiceRegistryAndSupervision

deleteService

Unregister a service

+
+

/services/{serviceId}

Usage and SDK Samples

+ +

curl -X DELETE \
+ -H "Accept: */*,application/problem+json" \
+ "https://example.com/a1-policy-management/v1/services/{serviceId}"
+

import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.ServiceRegistryAndSupervisionApi;
+
+import java.io.File;
+import java.util.*;
+
+public class ServiceRegistryAndSupervisionApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        ServiceRegistryAndSupervisionApi apiInstance = new ServiceRegistryAndSupervisionApi();
+        String serviceId = serviceId_example; // String | 
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            Object result = apiInstance.deleteService(serviceId, accept);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling ServiceRegistryAndSupervisionApi#deleteService");
+            e.printStackTrace();
+        }
+    }
+}
+

+ +

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String serviceId = new String(); // String | 
+final String accept = new String(); // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    final result = await api_instance.deleteService(serviceId, accept);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->deleteService: $e\n');
+}
+
+

+ +

import org.openapitools.client.api.ServiceRegistryAndSupervisionApi;
+
+public class ServiceRegistryAndSupervisionApiExample {
+    public static void main(String[] args) {
+        ServiceRegistryAndSupervisionApi apiInstance = new ServiceRegistryAndSupervisionApi();
+        String serviceId = serviceId_example; // String | 
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            Object result = apiInstance.deleteService(serviceId, accept);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling ServiceRegistryAndSupervisionApi#deleteService");
+            e.printStackTrace();
+        }
+    }
+}

+ +


+
+// Create an instance of the API class
+ServiceRegistryAndSupervisionApi *apiInstance = [[ServiceRegistryAndSupervisionApi alloc] init];
+String *serviceId = serviceId_example; //  (default to null)
+String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+[apiInstance deleteServiceWith:serviceId
+    accept:accept
+              completionHandler: ^(Object output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+

+ +

var A1PolicyManagementApi = require('a1_policy_management_api');
+
+// Create an instance of the API class
+var api = new A1PolicyManagementApi.ServiceRegistryAndSupervisionApi()
+var serviceId = serviceId_example; // {String} 
+var opts = {
+  'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.deleteService(serviceId, opts, callback);
+

+ + +

using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class deleteServiceExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new ServiceRegistryAndSupervisionApi();
+            var serviceId = serviceId_example;  // String |  (default to null)
+            var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)
+
+            try {
+                Object result = apiInstance.deleteService(serviceId, accept);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling ServiceRegistryAndSupervisionApi.deleteService: " + e.Message );
+            }
+        }
+    }
+}
+

+ +

<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\ServiceRegistryAndSupervisionApi();
+$serviceId = serviceId_example; // String | 
+$accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    $result = $api_instance->deleteService($serviceId, $accept);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling ServiceRegistryAndSupervisionApi->deleteService: ', $e->getMessage(), PHP_EOL;
+}
+?>

+ +

use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::ServiceRegistryAndSupervisionApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::ServiceRegistryAndSupervisionApi->new();
+my $serviceId = serviceId_example; # String | 
+my $accept = application/json; # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+eval {
+    my $result = $api_instance->deleteService(serviceId => $serviceId, accept => $accept);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling ServiceRegistryAndSupervisionApi->deleteService: $@\n";
+}

+ +

from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.ServiceRegistryAndSupervisionApi()
+serviceId = serviceId_example # String |  (default to null)
+accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+try:
+    api_response = api_instance.delete_service(serviceId, accept=accept)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling ServiceRegistryAndSupervisionApi->deleteService: %s\n" % e)

+ +

extern crate ServiceRegistryAndSupervisionApi;
+
+pub fn main() {
+    let serviceId = serviceId_example; // String
+    let accept = application/json; // String
+
+    let mut context = ServiceRegistryAndSupervisionApi::Context::default();
+    let result = client.deleteService(serviceId, accept, &context).wait();
+
+    println!("{:?}", result);
+}
+

+ +

Scopes

+ + +

+ +

Parameters

+ +

Path parameters

+ + + + + + + + + +

Name	Description
serviceId*	+ + + + + + + String + + + + + Required + + + +

+ +

Header parameters

+ + + + + + + + + +

Name	Description
Accept	+ + + + + + + String + + + +Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. + + + + +

+ + + + +

Responses

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

getServices

Returns service information

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

+
+

/services

Usage and SDK Samples

+ +

curl -X GET \
+ -H "Accept: application/json,application/problem+json" \
+ "https://example.com/a1-policy-management/v1/services?serviceId=serviceId_example"
+

import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.ServiceRegistryAndSupervisionApi;
+
+import java.io.File;
+import java.util.*;
+
+public class ServiceRegistryAndSupervisionApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        ServiceRegistryAndSupervisionApi apiInstance = new ServiceRegistryAndSupervisionApi();
+        String serviceId = serviceId_example; // String | The identity of the service
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            ServiceStatusList result = apiInstance.getServices(serviceId, accept);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling ServiceRegistryAndSupervisionApi#getServices");
+            e.printStackTrace();
+        }
+    }
+}
+

+ +

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String serviceId = new String(); // String | The identity of the service
+final String accept = new String(); // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    final result = await api_instance.getServices(serviceId, accept);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getServices: $e\n');
+}
+
+

+ +

import org.openapitools.client.api.ServiceRegistryAndSupervisionApi;
+
+public class ServiceRegistryAndSupervisionApiExample {
+    public static void main(String[] args) {
+        ServiceRegistryAndSupervisionApi apiInstance = new ServiceRegistryAndSupervisionApi();
+        String serviceId = serviceId_example; // String | The identity of the service
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+        try {
+            ServiceStatusList result = apiInstance.getServices(serviceId, accept);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling ServiceRegistryAndSupervisionApi#getServices");
+            e.printStackTrace();
+        }
+    }
+}

+ +


+
+// Create an instance of the API class
+ServiceRegistryAndSupervisionApi *apiInstance = [[ServiceRegistryAndSupervisionApi alloc] init];
+String *serviceId = serviceId_example; // The identity of the service (optional) (default to null)
+String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+// Returns service information
+[apiInstance getServicesWith:serviceId
+    accept:accept
+              completionHandler: ^(ServiceStatusList output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+

+ +

var A1PolicyManagementApi = require('a1_policy_management_api');
+
+// Create an instance of the API class
+var api = new A1PolicyManagementApi.ServiceRegistryAndSupervisionApi()
+var opts = {
+  'serviceId': serviceId_example, // {String} The identity of the service
+  'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getServices(opts, callback);
+

+ + +

using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class getServicesExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new ServiceRegistryAndSupervisionApi();
+            var serviceId = serviceId_example;  // String | The identity of the service (optional)  (default to null)
+            var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)
+
+            try {
+                // Returns service information
+                ServiceStatusList result = apiInstance.getServices(serviceId, accept);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling ServiceRegistryAndSupervisionApi.getServices: " + e.Message );
+            }
+        }
+    }
+}
+

+ +

<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\ServiceRegistryAndSupervisionApi();
+$serviceId = serviceId_example; // String | The identity of the service
+$accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+try {
+    $result = $api_instance->getServices($serviceId, $accept);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling ServiceRegistryAndSupervisionApi->getServices: ', $e->getMessage(), PHP_EOL;
+}
+?>

+ +

use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::ServiceRegistryAndSupervisionApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::ServiceRegistryAndSupervisionApi->new();
+my $serviceId = serviceId_example; # String | The identity of the service
+my $accept = application/json; # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+
+eval {
+    my $result = $api_instance->getServices(serviceId => $serviceId, accept => $accept);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling ServiceRegistryAndSupervisionApi->getServices: $@\n";
+}

+ +

from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.ServiceRegistryAndSupervisionApi()
+serviceId = serviceId_example # String | The identity of the service (optional) (default to null)
+accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+
+try:
+    # Returns service information
+    api_response = api_instance.get_services(serviceId=serviceId, accept=accept)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling ServiceRegistryAndSupervisionApi->getServices: %s\n" % e)

+ +

extern crate ServiceRegistryAndSupervisionApi;
+
+pub fn main() {
+    let serviceId = serviceId_example; // String
+    let accept = application/json; // String
+
+    let mut context = ServiceRegistryAndSupervisionApi::Context::default();
+    let result = client.getServices(serviceId, accept, &context).wait();
+
+    println!("{:?}", result);
+}
+

+ +

Scopes

+ + +

+ +

Parameters

+ + +

Header parameters

+ + + + + + + + + +

Name	Description
Accept	+ + + + + + + String + + + +Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. + + + + +

+ + + +

Query parameters

+ + + + + + + + + +

Name	Description
serviceId	+ + + + + + + String + + + +The identity of the service + + + + +

+ +

Responses

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

keepAliveService

Heartbeat indicates that the service is running

+
+

/services/{serviceId}/keepalive

Usage and SDK Samples

+ +

curl -X PUT \
+ -H "Accept: */*,application/problem+json" \
+ -H "Content-Type: application/json" \
+ "https://example.com/a1-policy-management/v1/services/{serviceId}/keepalive" \
+ -d ''
+

import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.ServiceRegistryAndSupervisionApi;
+
+import java.io.File;
+import java.util.*;
+
+public class ServiceRegistryAndSupervisionApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        ServiceRegistryAndSupervisionApi apiInstance = new ServiceRegistryAndSupervisionApi();
+        String serviceId = serviceId_example; // String | 
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+        String body = body_example; // String | 
+
+        try {
+            Object result = apiInstance.keepAliveService(serviceId, accept, body);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling ServiceRegistryAndSupervisionApi#keepAliveService");
+            e.printStackTrace();
+        }
+    }
+}
+

+ +

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String serviceId = new String(); // String | 
+final String accept = new String(); // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+final String body = new String(); // String | 
+
+try {
+    final result = await api_instance.keepAliveService(serviceId, accept, body);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->keepAliveService: $e\n');
+}
+
+

+ +

import org.openapitools.client.api.ServiceRegistryAndSupervisionApi;
+
+public class ServiceRegistryAndSupervisionApiExample {
+    public static void main(String[] args) {
+        ServiceRegistryAndSupervisionApi apiInstance = new ServiceRegistryAndSupervisionApi();
+        String serviceId = serviceId_example; // String | 
+        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+        String body = body_example; // String | 
+
+        try {
+            Object result = apiInstance.keepAliveService(serviceId, accept, body);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling ServiceRegistryAndSupervisionApi#keepAliveService");
+            e.printStackTrace();
+        }
+    }
+}

+ +


+
+// Create an instance of the API class
+ServiceRegistryAndSupervisionApi *apiInstance = [[ServiceRegistryAndSupervisionApi alloc] init];
+String *serviceId = serviceId_example; //  (default to null)
+String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+String *body = body_example; //  (optional)
+
+// Heartbeat indicates that the service is running
+[apiInstance keepAliveServiceWith:serviceId
+    accept:accept
+    body:body
+              completionHandler: ^(Object output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+

+ +

var A1PolicyManagementApi = require('a1_policy_management_api');
+
+// Create an instance of the API class
+var api = new A1PolicyManagementApi.ServiceRegistryAndSupervisionApi()
+var serviceId = serviceId_example; // {String} 
+var opts = {
+  'accept': application/json, // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+  'body': body_example // {String} 
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.keepAliveService(serviceId, opts, callback);
+

+ + +

using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class keepAliveServiceExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new ServiceRegistryAndSupervisionApi();
+            var serviceId = serviceId_example;  // String |  (default to null)
+            var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)
+            var body = body_example;  // String |  (optional) 
+
+            try {
+                // Heartbeat indicates that the service is running
+                Object result = apiInstance.keepAliveService(serviceId, accept, body);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling ServiceRegistryAndSupervisionApi.keepAliveService: " + e.Message );
+            }
+        }
+    }
+}
+

+ +

<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\ServiceRegistryAndSupervisionApi();
+$serviceId = serviceId_example; // String | 
+$accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+$body = body_example; // String | 
+
+try {
+    $result = $api_instance->keepAliveService($serviceId, $accept, $body);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling ServiceRegistryAndSupervisionApi->keepAliveService: ', $e->getMessage(), PHP_EOL;
+}
+?>

+ +

use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::ServiceRegistryAndSupervisionApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::ServiceRegistryAndSupervisionApi->new();
+my $serviceId = serviceId_example; # String | 
+my $accept = application/json; # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
+my $body = WWW::OPenAPIClient::Object::String->new(); # String | 
+
+eval {
+    my $result = $api_instance->keepAliveService(serviceId => $serviceId, accept => $accept, body => $body);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling ServiceRegistryAndSupervisionApi->keepAliveService: $@\n";
+}

+ +

from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.ServiceRegistryAndSupervisionApi()
+serviceId = serviceId_example # String |  (default to null)
+accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
+body = body_example # String |  (optional)
+
+try:
+    # Heartbeat indicates that the service is running
+    api_response = api_instance.keep_alive_service(serviceId, accept=accept, body=body)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling ServiceRegistryAndSupervisionApi->keepAliveService: %s\n" % e)

+ +

extern crate ServiceRegistryAndSupervisionApi;
+
+pub fn main() {
+    let serviceId = serviceId_example; // String
+    let accept = application/json; // String
+    let body = body_example; // String
+
+    let mut context = ServiceRegistryAndSupervisionApi::Context::default();
+    let result = client.keepAliveService(serviceId, accept, body, &context).wait();
+
+    println!("{:?}", result);
+}
+

+ +

Scopes

+ + +

+ +

Parameters

+ +

Path parameters

+ + + + + + + + + +

Name	Description
serviceId*	+ + + + + + + String + + + + + Required + + + +

+ +

Header parameters

+ + + + + + + + + +

Name	Description
Accept	+ + + + + + + String + + + +Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. + + + + +

+ +

Body parameters

+ + + + + + + + + +

Name	Description
body	+ + + +

+ + + +

Responses

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

putService

+
+

/services

Usage and SDK Samples

+ +

curl -X PUT \
+ -H "Accept: */*,application/problem+json" \
+ -H "Content-Type: application/json" \
+ "https://example.com/a1-policy-management/v1/services" \
+ -d '{
+  "keepAliveIntervalSeconds" : 0,
+  "callbackUrl" : "callbackUrl",
+  "serviceId" : "serviceId"
+}'
+

import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.ServiceRegistryAndSupervisionApi;
+
+import java.io.File;
+import java.util.*;
+
+public class ServiceRegistryAndSupervisionApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        ServiceRegistryAndSupervisionApi apiInstance = new ServiceRegistryAndSupervisionApi();
+        ServiceRegistrationInfo serviceRegistrationInfo = ; // ServiceRegistrationInfo | 
+
+        try {
+            Object result = apiInstance.putService(serviceRegistrationInfo);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling ServiceRegistryAndSupervisionApi#putService");
+            e.printStackTrace();
+        }
+    }
+}
+

+ +

import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final ServiceRegistrationInfo serviceRegistrationInfo = new ServiceRegistrationInfo(); // ServiceRegistrationInfo | 
+
+try {
+    final result = await api_instance.putService(serviceRegistrationInfo);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->putService: $e\n');
+}
+
+

+ +

import org.openapitools.client.api.ServiceRegistryAndSupervisionApi;
+
+public class ServiceRegistryAndSupervisionApiExample {
+    public static void main(String[] args) {
+        ServiceRegistryAndSupervisionApi apiInstance = new ServiceRegistryAndSupervisionApi();
+        ServiceRegistrationInfo serviceRegistrationInfo = ; // ServiceRegistrationInfo | 
+
+        try {
+            Object result = apiInstance.putService(serviceRegistrationInfo);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling ServiceRegistryAndSupervisionApi#putService");
+            e.printStackTrace();
+        }
+    }
+}

+ +


+
+// Create an instance of the API class
+ServiceRegistryAndSupervisionApi *apiInstance = [[ServiceRegistryAndSupervisionApi alloc] init];
+ServiceRegistrationInfo *serviceRegistrationInfo = ; // 
+
+// Register a service
+[apiInstance putServiceWith:serviceRegistrationInfo
+              completionHandler: ^(Object output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+

+ +

var A1PolicyManagementApi = require('a1_policy_management_api');
+
+// Create an instance of the API class
+var api = new A1PolicyManagementApi.ServiceRegistryAndSupervisionApi()
+var serviceRegistrationInfo = ; // {ServiceRegistrationInfo} 
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.putService(serviceRegistrationInfo, callback);
+

+ + +

using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class putServiceExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new ServiceRegistryAndSupervisionApi();
+            var serviceRegistrationInfo = new ServiceRegistrationInfo(); // ServiceRegistrationInfo | 
+
+            try {
+                // Register a service
+                Object result = apiInstance.putService(serviceRegistrationInfo);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling ServiceRegistryAndSupervisionApi.putService: " + e.Message );
+            }
+        }
+    }
+}
+

+ +

<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\ServiceRegistryAndSupervisionApi();
+$serviceRegistrationInfo = ; // ServiceRegistrationInfo | 
+
+try {
+    $result = $api_instance->putService($serviceRegistrationInfo);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling ServiceRegistryAndSupervisionApi->putService: ', $e->getMessage(), PHP_EOL;
+}
+?>

+ +

use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::ServiceRegistryAndSupervisionApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::ServiceRegistryAndSupervisionApi->new();
+my $serviceRegistrationInfo = WWW::OPenAPIClient::Object::ServiceRegistrationInfo->new(); # ServiceRegistrationInfo | 
+
+eval {
+    my $result = $api_instance->putService(serviceRegistrationInfo => $serviceRegistrationInfo);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling ServiceRegistryAndSupervisionApi->putService: $@\n";
+}

+ +

from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.ServiceRegistryAndSupervisionApi()
+serviceRegistrationInfo =  # ServiceRegistrationInfo | 
+
+try:
+    # Register a service
+    api_response = api_instance.put_service(serviceRegistrationInfo)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling ServiceRegistryAndSupervisionApi->putService: %s\n" % e)

+ +

extern crate ServiceRegistryAndSupervisionApi;
+
+pub fn main() {
+    let serviceRegistrationInfo = ; // ServiceRegistrationInfo
+
+    let mut context = ServiceRegistryAndSupervisionApi::Context::default();
+    let result = client.putService(serviceRegistrationInfo, &context).wait();
+
+    println!("{:?}", result);
+}
+

+ +

Scopes

+ + +

+ +

Parameters

+ + + +

Body parameters

+ + + + + + + + + +

Name	Description
serviceRegistrationInfo *	+ + + +

+ + + +

Responses

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

+ + + +

+ Schema +

+ + +

+ +

General

The O-RAN Non-RT RIC Policy Management Service provides a REST API for managemecnt of A1 policies.
The main tasks of the service are:

A1 Policy creation, modification and deletion.
Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs
Maintaining a view of supported Near-RT RIC policy types
Supervision of using services (R-APPs). When a service is unavailable, its policies are removed.

APIs provided or defined by the service

A1 Policy Management

This is an API for management of A1 Policies.

A1 Policy retrieval, creation, modification and deletion.
Retrieval of supported A1 Policy types for a Near-RT RIC
Retrieval of status for existing A1 policies

Management of configuration

API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.

Service callbacks

These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.

NearRT-RIC Repository

This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted for one Near-RT RIC.

Health Check

API used for supervision of the PMS component.

Service Registry and Supervision

Authorization API

API used for access control of A1 Policy access. If configured, an external authorization provider is requested to grant access to the A1 Policy type.

Get callbacks about available NearRT RICs.
Activate supervision of the service. If a service is inactive, its policies will automatically be deleted.

General

The O-RAN Non-RT RIC Policy Management Service\ + \ provides a REST API for managemecnt of A1 policies.
The main tasks of the\ + \ service are:

A1 Policy creation, modification and deletion.
Monitoring\ + \ and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs
Maintaining\ + \ a view of supported Near-RT RIC policy types
Supervision of using services\ + \ (R-APPs). When a service is unavailable, its policies are removed.

APIs\ + \ provided or defined by the service

A1 Policy Management

This\ + \ is an API for management of A1 Policies.

A1 Policy retrieval, creation,\ + \ modification and deletion.
Retrieval of supported A1 Policy types for\ + \ a Near-RT RIC
Retrieval of status for existing A1 policies

Management\ + \ of configuration

API for updating and retrieval of the component configuration.\ + \ Note that there other ways to maintain the configuration.

Service callbacks

These\ + \ are endpoints that are invoked by this service. The callbacks are registered\ + \ in this service at service registration.

NearRT-RIC Repository

This\ + \ is an API that provides support for looking up a NearRT-RIC. Each A1 policy\ + \ is targeted for one Near-RT RIC.

Health Check

API used for supervision\ + \ of the PMS component.

Service Registry and Supervision

API used\ + \ for registering services that uses PMS. Each A1 policy is optionally owned by\ + \ a service. PMS can supervise each registered service by a heart-beat supervision\ + \ and will automatically remove policies for unavailable services. Note that a\ + \ service does not need to be registered in order to create A1 Policies. This\ + \ is a feature that is optional to use.

Authorization API

API used\ + \ for access control of A1 Policy access. If configured, an external authorization\ + \ provider is requested to grant access to the A1 Policy type.

" + license: + name: Copyright (C) 2024 OpenInfra Foundation Europe. Licensed under the Apache License. + url: http://www.apache.org/licenses/LICENSE-2.0 + contact: + url: https://www.onap.org/ + email: discuss-list@onap.com +servers: + - url: '{apiRoot}/a1-policy-management/v1' + variables: + apiRoot: + default: 'https://example.com' + description: 'This is the Host:Port or Address where the A1-Policy Management Service can be accessed' +tags: + - name: A1 Policy Management + description: "API used to create polices, Policy Instances and get \ them as individual using an ID or get all policies/Instances." + - name: NearRT-RIC Repository + description: "API used to get the NearRT-RIC for the managed element." + - name: Service Registry and Supervision + description: "API used to keep the service Alive with in the timeout period" + - name: Health Check + description: "API used to get the health status and statistics of this service" + - name: Service callbacks + - name: Configuration + description: "API used to create or fetch the application configuration." +paths: + /status: + get: + operationId: getStatus + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/StatusInfo' + examples: + status_info: + $ref: '#/components/examples/StatusInfo' + description: OK- Service is living Ok + description: Returns status and statistics of this service + tags: + - Health Check + /rics/ric: + get: + description: Either a Near-RT RIC identity or a Managed Element identity can + be specified.
The intention with Managed Element identity is the ID used + in O1 for accessing the traffical element (such as the ID of CU). + operationId: getRic + parameters: + - description: "The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned." + explode: true + in: query + name: managedElementId + required: false + schema: + type: string + style: form + - description: The identity of a Near-RT RIC to get information for. + explode: true + in: query + name: ricId + required: false + schema: + type: string + style: form + - description: Specifies the content type that the client expects to receive in response to the request. + Only application/json is allowed. + in: header + name: Accept + schema: + type: string + example: application/json + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/RicInfo' + examples: + ric_info: + $ref: '#/components/examples/RicInfo' + description: OK - Near-RT RIC is found OK + "404": + $ref: '#/components/responses/404' + summary: Returns info for one Near-RT RIC + tags: + - NearRT-RIC Repository + /rics: + get: + description: The call returns all Near-RT RICs that supports a given policy + type identity + operationId: getRics + parameters: + - description: "The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned" + explode: true + in: query + name: policyTypeId + required: false + schema: + type: string + style: form + - description: Specifies the content type that the client expects to receive in response to the request. + Only application/json is allowed. + in: header + name: Accept + schema: + type: string + example: application/json + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/RicInfoList' + examples: + ric_info_list: + $ref: '#/components/examples/RicInfoList' + description: OK + "404": + $ref: '#/components/responses/404' + summary: Query Near-RT RIC information + tags: + - NearRT-RIC Repository + /policy-types: + get: + operationId: getPolicyTypes + parameters: + - description: Select types for the given Near-RT RIC identity. + explode: true + in: query + name: nearRtRicId + required: false + schema: + type: string + style: form + - description: Select types with the given type name (type identity has the + format ) + explode: true + in: query + name: typeName + required: false + schema: + type: string + style: form + - description: 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. + explode: true + in: query + name: compatibleWithVersion + required: false + schema: + type: string + style: form + - description: Specifies the content type that the client expects to receive in response to the request. + Only application/json is allowed. + in: header + name: Accept + schema: + type: string + example: application/json + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/PolicyTypeInformation' + type: array + + description: OK - Policy Type IDs found Ok + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + '502': + $ref: '#/components/responses/502' + '503': + $ref: '#/components/responses/503' + description: Query policy type identities + tags: + - A1 Policy Management + /policy-types/{policyTypeId}: + get: + operationId: getPolicyTypeDefinition + parameters: + - explode: false + in: path + name: policyTypeId + required: true + schema: + type: string + style: simple + - description: Specifies the content type that the client expects to receive in response to the request. + Only application/json is allowed. + in: header + name: Accept + schema: + type: string + example: application/json + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyObject' + examples: + policyObject: + $ref: '#/components/examples/PolicyObject' + description: OK - schema of the given policy type + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + '502': + $ref: '#/components/responses/502' + '503': + $ref: '#/components/responses/503' + description: Returns a policy type definition + tags: + - A1 Policy Management + /policies/{policyId}: + put: + operationId: putPolicy + parameters: + - name: policyId + in: path + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyObject' + examples: + policyObject: + $ref: '#/components/examples/PolicyObject' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyObject' + description: OK - Policy updated + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '411': + $ref: '#/components/responses/411' + '413': + $ref: '#/components/responses/413' + '415': + $ref: '#/components/responses/415' + '423': + $ref: '#/components/responses/Locked' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + '502': + $ref: '#/components/responses/502' + '503': + $ref: '#/components/responses/503' + description: update a policy + tags: + - A1 Policy Management + delete: + description: Deleting the policy using policyId. + operationId: deletePolicy + parameters: + - explode: false + in: path + name: policyId + required: true + schema: + type: string + style: simple + - description: Specifies the content type that the client expects to receive in response to the request. + Only application/json is allowed. + in: header + name: Accept + schema: + type: string + example: application/json + responses: + '204': + description: 'The created A1 policy was deleted' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '423': + $ref: '#/components/responses/Locked' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + '502': + $ref: '#/components/responses/502' + '503': + $ref: '#/components/responses/503' + summary: Delete a policy + tags: + - A1 Policy Management + get: + operationId: getPolicy + parameters: + - explode: false + in: path + name: policyId + required: true + schema: + type: string + style: simple + - description: Specifies the content type that the client expects to receive in response to the request. + Only application/json is allowed. + in: header + name: Accept + schema: + type: string + example: application/json + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyObject' + examples: + policyObject: + $ref: '#/components/examples/PolicyObject' + description: OK - Policy found + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + '502': + $ref: '#/components/responses/502' + '503': + $ref: '#/components/responses/503' + description: Returns a policy + tags: + - A1 Policy Management + /policies: + get: + description: "Returns a list of A1 policies matching given search criteria.\ + \
If several query parameters are defined, the policies matching all conditions\ + \ are returned." + operationId: getAllPolicies + parameters: + - description: Select policies of a given policy type identity. + explode: true + in: query + name: policyTypeId + required: false + schema: + type: string + style: form + - description: Select policies of a given Near-RT RIC identity. + explode: true + in: query + name: nearRtRicId + required: false + schema: + type: string + style: form + - description: Select policies owned by a given service. + explode: true + in: query + name: serviceId + required: false + schema: + type: string + style: form + - description: Select policies of types with the given type name (type identity + has the format ) + explode: true + in: query + name: typeName + required: false + schema: + type: string + style: form + - description: Specifies the content type that the client expects to receive in response to the request. + Only application/json is allowed. + in: header + name: Accept + schema: + type: string + example: application/json + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/PolicyInformation' + type: array + description: OK - Policy identities + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + '502': + $ref: '#/components/responses/502' + '503': + $ref: '#/components/responses/503' + summary: Query policy identities + tags: + - A1 Policy Management + post: + operationId: createPolicy + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyObjectInformation' + responses: + '201': + description: 'Success case 201 created' + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyObjectInformation' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '423': + $ref: '#/components/responses/Locked' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + '502': + $ref: '#/components/responses/502' + '503': + $ref: '#/components/responses/503' + description: 'To create A1 policies' + tags: + - A1 Policy Management + /configuration: + get: + operationId: getConfiguration + responses: + "200": + content: + application/json: + schema: + type: string + description: OK - Application configuration received + "404": + $ref: '#/components/responses/404' + + description: Returns the contents of the application configuration + tags: + - Configuration + put: + operationId: putConfiguration + requestBody: + content: + application/json: + schema: + type: object + required: true + responses: + "200": + content: + '*/*': + schema: + $ref: '#/components/schemas/void' + description: OK - Configuration updated + "400": + $ref: '#/components/responses/400' + description: Replace the current configuration file with the given configuration + tags: + - Configuration + /services/{serviceId}/keepalive: + put: + description: 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) + operationId: keepAliveService + parameters: + - explode: false + in: path + name: serviceId + required: true + schema: + type: string + style: simple + - description: Specifies the content type that the client expects to receive in response to the request. + Only application/json is allowed. + in: header + name: Accept + schema: + type: string + example: application/json + requestBody: + required: false + content: + application/json: + schema: + type: string + responses: + "200": + content: + '*/*': + schema: + type: object + description: "OK - Service supervision timer refreshed, OK" + "404": + $ref: '#/components/responses/404' + summary: Heartbeat indicates that the service is running + tags: + - Service Registry and Supervision + /services: + get: + description: Either information about a registered service with given identity + or all registered services are returned. + operationId: getServices + parameters: + - description: The identity of the service + explode: true + in: query + name: serviceId + required: false + schema: + type: string + style: form + - description: Specifies the content type that the client expects to receive in response to the request. + Only application/json is allowed. + in: header + name: Accept + schema: + type: string + example: application/json + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceStatusList' + examples: + service_status_list: + $ref: '#/components/examples/ServiceStatusList' + description: OK + "404": + $ref: '#/components/responses/404' + summary: Returns service information + tags: + - Service Registry and Supervision + put: + description: "Registering a service is needed to:

Get callbacks about\ + \ available NearRT RICs.
Activate supervision of the service. If a\ + \ service is inactive, its policies will automatically be deleted.

Policies\ + \ can be created even if the service is not registerred. This is a feature\ + \ which it is optional to use." + operationId: putService + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceRegistrationInfo' + required: true + responses: + "200": + content: + '*/*': + schema: + type: object + description: OK - Service updated + "201": + content: + '*/*': + schema: + type: object + description: Created - Service created + "400": + $ref: '#/components/responses/400' + summary: Register a service + tags: + - Service Registry and Supervision + callbacks: + RICStatus: + "{$request.body#/callback_url}": + post: + description: The URL to this call is registered at Service registration. + operationId: serviceCallback + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceCallbackInfo' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/void' + description: OK + "404": + $ref: '#/components/responses/404' + summary: Callback for Near-RT RIC status + tags: + - Service callbacks + /services/{serviceId}: + delete: + operationId: deleteService + parameters: + - explode: false + in: path + name: serviceId + required: true + schema: + type: string + style: simple + - description: Specifies the content type that the client expects to receive in response to the request. + Only application/json is allowed. + in: header + name: Accept + schema: + type: string + example: application/json + responses: + "204": + content: + '*/*': + schema: + type: object + description: No Content - Service unregistered + "404": + $ref: '#/components/responses/404' + description: Unregister a service + tags: + - Service Registry and Supervision +components: + examples: + ServiceStatusList: + description: List of service information + value: + serviceList: + - callbackUrl: callbackUrl + serviceId: serviceId + keepAliveIntervalSeconds: 0 + timeSinceLastActivitySeconds: 6 + - callbackUrl: callbackUrl + serviceId: serviceId + keepAliveIntervalSeconds: 0 + timeSinceLastActivitySeconds: 6 + PolicyStatusInfo: + description: Status for one A1-P Policy + value: + lastModified: last_modified + status: + value: + status: status + StatusInfo: + value: + status: status + RicInfo: + value: + ricId: ricId + managedElementIds: + - managedElementId + - managedElementId + state: UNAVAILABLE + policyTypeIds: + - policyTypeId + - policyTypeId + RicInfoList: + value: + rics: + - ricId: ricId + managedElementIds: + - managedElementId + - managedElementId + state: UNAVAILABLE + policyTypeIds: + - policyTypeId + - policyTypeId + - ricId: ricId + managedElementIds: + - managedElementId + - managedElementId + state: UNAVAILABLE + policyTypeIds: + - policyTypeId + - policyTypeId + PolicyObject: + value: + scope: + ueId: + guRanUeId: + globalGnbId: + plmnId: + mcc: "123" + mnc: "45" + gnbId: + gnbIdLength: 24 + gnbIdValue: 12345678 + RanUeId: 'a31c510b20e64a74' + groupId: + spId: 123 + qosId: + 5qI: 1 + cellId: + plmnId: + mcc: "123" + mnc: "45" + cId: + ncI: 123 + qosObjectives: + gfbr: 100 + mfbr: 200 + priorityLevel: 3 + pdb: 50 + schemas: + PolicyTypeInformation: + description: >- + Available policy types and for each policy type identifier the Near-RT + RIC identifiers of those Near-RT RICs that support the related A1 policy + type + type: object + properties: + policyTypeId: + description: Identity of the policy type + type: string + nearRtRicId: + $ref: '#/components/schemas/NearRtRicId' + required: + - policyTypeId + - nearRtRicId + PolicyObjectInformation: + description: Information related to the creation of the policy + type: object + properties: + nearRtRicId: + description: identity of the target Near-RT RIC + type: string + example: + 'Near-RT-Ric-ID' + transient: + default: false + description: "if true, the policy is deleted at RIC restart. If false, its\ + \ value is maintained by this service until explicitly deleted. Default\ + \ false." + nullable: false + type: boolean + policyId: + description: identity of the Policy + type: string + example: + 'POLICY-ID' + serviceId: + description: the identity of the service owning the policy. This can be + used to group the policies (it is possible to get all policies associated + to a service). Note that the service does not need to be registered. + type: string + example: + 'rApp ID' + policyObject: + $ref: '#/components/schemas/PolicyObject' + policyTypeId: + description: identity of the policy type + type: string + example: 'ORAN_QOS_1.0.0(typeName_SemVersion)' + required: + - nearRtRicId + - policyObject + - policyTypeId + ErrorInformation: + description: Problem as defined in https://tools.ietf.org/html/rfc7807 + properties: + detail: + description: ' A human-readable explanation specific to this occurrence + of the problem.' + example: Policy type not found + type: string + title: + description: 'A specific error name' + type: string + example: Not Found + status: + description: 'The HTTP status code generated by the origin server for this + occurrence of the problem. ' + example: 404 + format: int32 + type: integer + type: object + PolicyObject: + description: 'Policy Object is a JSON representation of an A1 policy' + type: object + void: + description: Void/empty + type: object + StatusInfo: + properties: + status: + description: status text + type: string + type: object + AuthorizationResult: + description: Result of authorization + example: + result: true + properties: + result: + description: "If true, the access is granted" + type: boolean + required: + - result + type: object + RicInfo: + description: Information for a Near-RT RIC + properties: + ricId: + description: identity of the Near-RT RIC + type: string + managedElementIds: + description: O1 identities for managed entities + items: + description: O1 identities for managed entities + type: string + type: array + state: + description: Represents the states for a Near-RT RIC + enum: + - UNAVAILABLE + - AVAILABLE + - SYNCHRONIZING + - CONSISTENCY_CHECK + type: string + policyTypeIds: + description: supported policy types + items: + description: supported policy types + type: string + type: array + type: object + ServiceRegistrationInfo: + description: Information for one service + properties: + callbackUrl: + description: callback for notifying of Near-RT RIC state changes + type: string + serviceId: + description: identity of the service + type: string + keepAliveIntervalSeconds: + description: "keep alive interval for the service. This is used to enable\ + \ optional heartbeat supervision of the service. If set (> 0) the registered\ + \ service should regularly invoke a 'keepalive' REST call. When a service\ + \ fails to invoke this 'keepalive' call within the configured time, the\ + \ service is considered unavailable. An unavailable service will be automatically\ + \ deregistered and its policies will be deleted. Value 0 means timeout\ + \ supervision is disabled." + format: int64 + type: integer + required: + - serviceId + type: object + PolicyStatusInfo: + description: Status for one A1-P Policy + properties: + lastModified: + description: "timestamp, last modification time" + type: string + status: + description: the Policy status + type: object + type: object + ServiceStatus: + properties: + callbackUrl: + description: callback for notifying of RIC synchronization + type: string + serviceId: + description: identity of the service + type: string + keepAliveIntervalSeconds: + description: policy keep alive timeout + format: int64 + type: integer + timeSinceLastActivitySeconds: + description: time since last invocation by the service + format: int64 + type: integer + type: object + RicInfoList: + description: List of Near-RT RIC information + properties: + rics: + description: List of Near-RT RIC information + items: + $ref: '#/components/schemas/RicInfo' + type: array + type: object + input: + description: input + properties: + accessType: + description: Access type + enum: + - READ + - WRITE + - DELETE + type: string + authToken: + description: Authorization token + type: string + policyTypeId: + description: Policy type identifier + type: string + required: + - accessType + - authToken + - policyTypeId + type: object + PolicyAuthorization: + description: Authorization request for A1 policy requests + properties: + input: + $ref: '#/components/schemas/input' + required: + - input + type: object + NearRtRicId: + description: Identity of the policy + type: string + PolicyInformation: + description: >- + Near-RT RIC identifiers where A1 policies exist and for each Near-RT RIC + identifier the policy identifiers of those policies that exist in that + Near-RT RIC + type: object + properties: + policyId: + description: Identity of the policy + type: string + nearRtRicId: + $ref: '#/components/schemas/NearRtRicId' + required: + - policyId + - nearRtRicId + ServiceStatusList: + properties: + serviceList: + description: List of service information + items: + $ref: '#/components/schemas/ServiceStatus' + type: array + type: object + ServiceCallbackInfo: + description: Information transferred as in Service callbacks (callback_url) + properties: + ricId: + description: identity of a Near-RT RIC + type: string + eventType: + description: "values:\nAVAILABLE: the Near-RT RIC has become available\ + \ for A1 Policy management" + enum: + - AVAILABLE + type: string + required: + - eventType + - ricId + type: object + Link: + properties: + templated: + type: boolean + href: + type: string + type: object + ProblemDetails: + description: >- + A problem detail to carry details in an HTTP response according to RFC + 7807 + type: object + properties: + type: + description: >- + a URI reference according to IETF RFC 3986 that identifies the + problem type + type: string + title: + description: human-readable summary of the problem type + type: string + status: + description: the HTTP status code + type: number + detail: + description: 'human-readable explanation ' + type: string + instance: + description: URI reference that identifies the specific occurrence of the problem + type: string + responses: + '400': + description: Bad Request + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: Unauthorized + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: Forbidden + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '405': + description: Method Not Allowed + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '406': + description: Not Acceptable + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '409': + description: Conflict + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '411': + description: Length Required + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '413': + description: Payload Too Large + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '415': + description: Unsupported Media Type + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: Too Many Request + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '500': + description: Internal Server Error + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '502': + description: Bad Gateway + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '503': + description: Service Unavailable + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + Locked: + description: "Locked - HTTP Status code which can be used when the state is Locked" + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ErrorInformation' + example: + status: 423 + title: Locked + detail: State is Locked in the provided request. diff --git a/docs/offeredapis/swagger/pms-api.json b/docs/offeredapis/swagger/pms-api.json index 5dd8b493..deb57430 100644 --- a/docs/offeredapis/swagger/pms-api.json +++ b/docs/offeredapis/swagger/pms-api.json @@ -1,1866 +1,1864 @@ -{ - "openapi" : "3.0.3", - "info" : { - "title" : "A1 Policy Management Service", - "description" : "

General

The O-RAN Non-RT RIC Policy Management Service provides a REST API for managemecnt of A1 policies.
The main tasks of the service are:

A1 Policy creation, modification and deletion.
Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs
Maintaining a view of supported Near-RT RIC policy types
Supervision of using services (R-APPs). When a service is unavailable, its policies are removed.

APIs provided or defined by the service

A1 Policy Management

This is an API for management of A1 Policies.

A1 Policy retrieval, creation, modification and deletion.
Retrieval of supported A1 Policy types for a Near-RT RIC
Retrieval of status for existing A1 policies

Management of configuration

API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.

Service callbacks

These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.

NearRT-RIC Repository

This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted for one Near-RT RIC.

Health Check

API used for supervision of the PMS component.

Service Registry and Supervision

Authorization API

API used for access control of A1 Policy access. If configured, an external authorization provider is requested to grant access to the A1 Policy type.

Spring Boot Actuator

Provides generic functions used to monitor and manage the Spring web application.

", - "contact" : { - "url" : "https://www.onap.org/", - "email" : "discuss-list@onap.com" - }, - "license" : { - "name" : "Copyright (C) 2020-2023 Nordix Foundation. Licensed under the Apache License.", - "url" : "http://www.apache.org/licenses/LICENSE-2.0" - }, - "version" : "1.3.0", - "x-api-id" : "a31c510b-20e6-4a08-af16-368c44d7fba8", - "x-audience" : "external-public" - }, - "servers" : [ { - "url" : "/" - } ], - "tags" : [ { - "name" : "A1 Policy Management", - "description" : "API used to create polices, Policy Instances and get them as individual using an ID or get all policies/Instances." - }, { - "name" : "NearRT-RIC Repository", - "description" : "API used to get the NearRT-RIC for the managed element." - }, { - "name" : "Service Registry and Supervision", - "description" : "API used to keep the service Alive with in the timeout period" - }, { - "name" : "Health Check", - "description" : "API used to get the health status and statistics of this service" - }, { - "name" : "Service callbacks" - }, { - "name" : "Authorization API", - "description" : "API used for authorization of information A1 policy access (this is provided by an authorization producer such as OPA).
Note that this API is called by PMS, it is not provided." - }, { - "name" : "Configuration", - "description" : "API used to create or fetch the application configuration." - }, { - "name" : "Actuator", - "description" : "Monitor and interact", - "externalDocs" : { - "description" : "Spring Boot Actuator Web API Documentation", - "url" : "https://docs.spring.io/spring-boot/docs/current/actuator-api/html/" - } - } ], - "paths" : { - "/a1-policy/v2/policy-instances" : { - "get" : { - "tags" : [ "A1 Policy Management" ], - "summary" : "Query for A1 policy instances", - "description" : "Returns a list of A1 policies matching given search criteria.
If several query parameters are defined, the policies matching all conditions are returned.", - "operationId" : "getPolicyInstances", - "parameters" : [ { - "name" : "policytype_id", - "in" : "query", - "description" : "Select policies with a given type identity.", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "string" - } - }, { - "name" : "ric_id", - "in" : "query", - "description" : "Select policies for a given Near-RT RIC identity.", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "string" - } - }, { - "name" : "service_id", - "in" : "query", - "description" : "Select policies owned by a given service.", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "string" - } - }, { - "name" : "type_name", - "in" : "query", - "description" : "Select policies of a given type name (type identity has the format )", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "OK - Returns A1 Policies which matches the criteria", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/policy_info_list" - }, - "examples" : { - "policy_info_list" : { - "$ref" : "#/components/examples/policy_info_list" - } - } - } - } - }, - "404" : { - "description" : "Not Found - Near-RT RIC, policy type or service not found", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/error_information" - } - } - } - } - } - } - }, - "/example-authz-check" : { - "post" : { - "tags" : [ "Authorization API" ], - "summary" : "Request for access authorization.", - "description" : "The authorization function decides if access is granted.", - "operationId" : "performAccessControl", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/policy_authorization" - } - } - }, - "required" : true - }, - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/authorization_result" - } - } - } - }, - "403" : { - "description" : "Forbidden", - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/error_information" - }, - "example" : { - "status" : 403, - "title" : "Forbidden", - "detail" : "Your role does not allow to perform this action. Contact System Administrator to change your access rights." - } - } - } - } - } - } - }, - "/actuator/threaddump" : { - "get" : { - "tags" : [ "Actuator" ], - "summary" : "Actuator web endpoint 'threaddump'", - "operationId" : "threaddump", - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "text/plain;charset=UTF-8" : { - "schema" : { - "type" : "object" - } - }, - "application/vnd.spring-boot.actuator.v3+json" : { - "schema" : { - "type" : "object" - } - }, - "application/json" : { - "schema" : { - "type" : "object" - } - }, - "application/vnd.spring-boot.actuator.v2+json" : { - "schema" : { - "type" : "object" - } - } - } - } - }, - "x-internal" : true - } - }, - "/a1-policy/v2/status" : { - "get" : { - "tags" : [ "Health Check" ], - "description" : "Returns status and statistics of this service", - "operationId" : "getStatus", - "responses" : { - "200" : { - "description" : "OK- Service is living Ok", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/status_info" - }, - "examples" : { - "status_info" : { - "$ref" : "#/components/examples/status_info" - } - } - } - } - } - } - } - }, - "/actuator/loggers" : { - "get" : { - "tags" : [ "Actuator" ], - "summary" : "Actuator web endpoint 'loggers'", - "operationId" : "loggers", - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "application/vnd.spring-boot.actuator.v3+json" : { - "schema" : { - "type" : "object" - } - }, - "application/json" : { - "schema" : { - "type" : "object" - } - }, - "application/vnd.spring-boot.actuator.v2+json" : { - "schema" : { - "type" : "object" - } - } - } - } - }, - "x-internal" : true - } - }, - "/actuator/health/**" : { - "get" : { - "tags" : [ "Actuator" ], - "summary" : "Actuator web endpoint 'health-path'", - "operationId" : "health-path", - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "application/vnd.spring-boot.actuator.v3+json" : { - "schema" : { - "type" : "object" - } - }, - "application/json" : { - "schema" : { - "type" : "object" - } - }, - "application/vnd.spring-boot.actuator.v2+json" : { - "schema" : { - "type" : "object" - } - } - } - } - }, - "x-internal" : true - } - }, - "/a1-policy/v2/rics/ric" : { - "get" : { - "tags" : [ "NearRT-RIC Repository" ], - "summary" : "Returns info of Near-RT RIC queried by the ric-id and managed-element-id", - "description" : "Either a Near-RT RIC identity or a Managed Element identity can be specified.
The intention with Managed Element identity is the ID used in O1 for accessing the traffical element (such as the ID of CU).", - "operationId" : "getRic", - "parameters" : [ { - "name" : "managed_element_id", - "in" : "query", - "description" : "The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "string" - } - }, { - "name" : "ric_id", - "in" : "query", - "description" : "The identity of a Near-RT RIC to get information for.", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "OK - Near-RT RIC is found", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ric_info" - }, - "examples" : { - "ric_info" : { - "$ref" : "#/components/examples/ric_info" - } - } - } - } - }, - "404" : { - "description" : "Not Found", - "content" : { - "application/problem+json" : { - "example" : [ ] - } - } - } - } - } - }, - "/actuator/shutdown" : { - "post" : { - "tags" : [ "Actuator" ], - "summary" : "Actuator web endpoint 'shutdown'", - "operationId" : "shutdown", - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "application/vnd.spring-boot.actuator.v3+json" : { - "schema" : { - "type" : "object" - } - }, - "application/json" : { - "schema" : { - "type" : "object" - } - }, - "application/vnd.spring-boot.actuator.v2+json" : { - "schema" : { - "type" : "object" - } - } - } - } - }, - "x-internal" : true - } - }, - "/a1-policy/v2/policy-types" : { - "get" : { - "tags" : [ "A1 Policy Management" ], - "description" : "Query policy type identities", - "operationId" : "getPolicyTypes", - "parameters" : [ { - "name" : "ric_id", - "in" : "query", - "description" : "Select types for the given Near-RT RIC identity.", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "string" - } - }, { - "name" : "type_name", - "in" : "query", - "description" : "Select types with the given type name (type identity has the format )", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "string" - } - }, { - "name" : "compatible_with_version", - "in" : "query", - "description" : "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.", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "OK - Policy Type IDs Found", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/policy_type_id_list" - }, - "examples" : { - "policy_type_id_list" : { - "$ref" : "#/components/examples/policy_type_id_list" - } - } - } - } - }, - "404" : { - "description" : "Not Found", - "content" : { - "application/problem+json" : { - "example" : [ ] - } - } - } - } - } - }, - "/a1-policy/v2/policies/{policy_id}" : { - "get" : { - "tags" : [ "A1 Policy Management" ], - "description" : "Returns a policy", - "operationId" : "getPolicy", - "parameters" : [ { - "name" : "policy_id", - "in" : "path", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "OK - Policy found", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/policy_info" - }, - "examples" : { - "policy_info" : { - "$ref" : "#/components/examples/policy_info" - } - } - } - } - }, - "404" : { - "description" : "Not Found", - "content" : { - "application/problem+json" : { - "example" : [ ] - } - } - } - } - }, - "delete" : { - "tags" : [ "A1 Policy Management" ], - "summary" : "Delete a policy", - "description" : "Deleting the policy using the Policy's Policy ID.", - "operationId" : "deletePolicy", - "parameters" : [ { - "name" : "policy_id", - "in" : "path", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "OK - Policy deleted", - "content" : { - "*/*" : { - "schema" : { - "$ref" : "#/components/schemas/void" - } - } - } - }, - "423" : { - "description" : "Locked - HTTP Status code which can be used when the state is Locked", - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/error_information" - }, - "example" : { - "status" : 423, - "title" : "Locked", - "detail" : "Requested resource is in a locked state." - } - } - } - } - } - } - }, - "/actuator/metrics/{requiredMetricName}" : { - "get" : { - "tags" : [ "Actuator" ], - "summary" : "Actuator web endpoint 'metrics-requiredMetricName'", - "operationId" : "metrics-requiredMetricName", - "parameters" : [ { - "name" : "requiredMetricName", - "in" : "path", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "application/vnd.spring-boot.actuator.v3+json" : { - "schema" : { - "type" : "object" - } - }, - "application/json" : { - "schema" : { - "type" : "object" - } - }, - "application/vnd.spring-boot.actuator.v2+json" : { - "schema" : { - "type" : "object" - } - } - } - } - }, - "x-internal" : true - } - }, - "/a1-policy/v2/configuration" : { - "get" : { - "tags" : [ "Configuration" ], - "description" : "Returns the contents of the application configuration file", - "operationId" : "getConfiguration", - "responses" : { - "200" : { - "description" : "OK - Configuration", - "content" : { - "application/json" : { - "schema" : { - "type" : "string" - } - } - } - }, - "404" : { - "description" : "Not Found", - "content" : { - "application/problem+json" : { - "example" : [ ] - } - } - } - }, - "x-internal" : true - }, - "put" : { - "tags" : [ "Configuration" ], - "description" : "Replace the current configuration with the given configuration", - "operationId" : "putConfiguration", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "object" - } - } - }, - "required" : true - }, - "responses" : { - "200" : { - "description" : "OK - Configuration updated", - "content" : { - "*/*" : { - "schema" : { - "$ref" : "#/components/schemas/void" - } - } - } - }, - "400" : { - "description" : "Bad Request", - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/error_information" - }, - "example" : { - "status" : 400, - "title" : "Bad Request", - "detail" : "The provided request is not valid." - } - } - } - } - }, - "x-internal" : true - } - }, - "/actuator" : { - "get" : { - "tags" : [ "Actuator" ], - "summary" : "Actuator root web endpoint", - "operationId" : "links", - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "application/vnd.spring-boot.actuator.v3+json" : { - "schema" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/Link" - } - } - } - }, - "application/json" : { - "schema" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/Link" - } - } - } - }, - "application/vnd.spring-boot.actuator.v2+json" : { - "schema" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/Link" - } - } - } - } - } - } - }, - "x-internal" : true - } - }, - "/actuator/loggers/{name}" : { - "get" : { - "tags" : [ "Actuator" ], - "summary" : "Actuator web endpoint 'loggers-name'", - "operationId" : "loggers-name", - "parameters" : [ { - "name" : "name", - "in" : "path", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "application/vnd.spring-boot.actuator.v3+json" : { - "schema" : { - "type" : "object" - } - }, - "application/json" : { - "schema" : { - "type" : "object" - } - }, - "application/vnd.spring-boot.actuator.v2+json" : { - "schema" : { - "type" : "object" - } - } - } - } - }, - "x-internal" : true - }, - "post" : { - "tags" : [ "Actuator" ], - "summary" : "Actuator web endpoint 'loggers-name'", - "operationId" : "loggers-name_2", - "parameters" : [ { - "name" : "name", - "in" : "path", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "type" : "string" - } - } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "string", - "enum" : [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL", "OFF" ] - } - } - } - }, - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "*/*" : { - "schema" : { - "type" : "object" - } - } - } - } - }, - "x-internal" : true - } - }, - "/a1-policy/v2/services/{service_id}/keepalive" : { - "put" : { - "tags" : [ "Service Registry and Supervision" ], - "summary" : "Heartbeat indicates that the service is running", - "description" : "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)", - "operationId" : "keepAliveService", - "parameters" : [ { - "name" : "service_id", - "in" : "path", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "OK - Service supervision timer refreshed, OK", - "content" : { - "*/*" : { - "schema" : { - "type" : "object" - } - } - } - }, - "404" : { - "description" : "Not Found", - "content" : { - "application/problem+json" : { - "example" : [ ] - } - } - } - } - } - }, - "/actuator/metrics" : { - "get" : { - "tags" : [ "Actuator" ], - "summary" : "Actuator web endpoint 'metrics'", - "operationId" : "metrics", - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "application/vnd.spring-boot.actuator.v3+json" : { - "schema" : { - "type" : "object" - } - }, - "application/json" : { - "schema" : { - "type" : "object" - } - }, - "application/vnd.spring-boot.actuator.v2+json" : { - "schema" : { - "type" : "object" - } - } - } - } - }, - "x-internal" : true - } - }, - "/a1-policy/v2/rics" : { - "get" : { - "tags" : [ "NearRT-RIC Repository" ], - "summary" : "Query Near-RT RIC information", - "description" : "The call returns all Near-RT RICs that supports a given policy type identity", - "operationId" : "getRics", - "parameters" : [ { - "name" : "policytype_id", - "in" : "query", - "description" : "The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ric_info_list" - }, - "examples" : { - "ric_info_list" : { - "$ref" : "#/components/examples/ric_info_list" - } - } - } - } - }, - "404" : { - "description" : "Not Found", - "content" : { - "application/problem+json" : { - "example" : [ ] - } - } - } - } - } - }, - "/a1-policy/v2/services" : { - "get" : { - "tags" : [ "Service Registry and Supervision" ], - "summary" : "Returns service information", - "description" : "Either information about a registered service with given identity or all registered services are returned.", - "operationId" : "getServices", - "parameters" : [ { - "name" : "service_id", - "in" : "query", - "description" : "The identity of the service", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/service_status_list" - }, - "examples" : { - "service_status_list" : { - "$ref" : "#/components/examples/service_status_list" - } - } - } - } - }, - "404" : { - "description" : "Not Found", - "content" : { - "application/problem+json" : { - "example" : [ ] - } - } - } - } - }, - "put" : { - "tags" : [ "Service Registry and Supervision" ], - "summary" : "Register a service", - "description" : "Registering a service is needed to:

Get callbacks about available NearRT RICs.
Activate supervision of the service. If a service is inactive, its policies will automatically be deleted.

Policies can be created even if the service is not registerred. This is a feature which it is optional to use.", - "operationId" : "putService", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/service_registration_info" - } - } - }, - "required" : true - }, - "responses" : { - "200" : { - "description" : "OK - Service updated", - "content" : { - "*/*" : { - "schema" : { - "type" : "object" - } - } - } - }, - "201" : { - "description" : "Created - Service created", - "content" : { - "*/*" : { - "schema" : { - "type" : "object" - } - } - } - }, - "400" : { - "description" : "Bad Request", - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/error_information" - }, - "example" : { - "status" : 400, - "title" : "Bad Request", - "detail" : "The provided request is not valid." - } - } - } - } - }, - "callbacks" : { - "RICStatus" : { - "{$request.body#/callback_url}" : { - "post" : { - "tags" : [ "Service callbacks" ], - "summary" : "Callback for Near-RT RIC status", - "description" : "The URL to this call is registered at Service registration.", - "operationId" : "serviceCallback", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/service_callback_info_v2" - } - } - }, - "required" : true - }, - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/void" - } - } - } - }, - "404" : { - "description" : "Not Found", - "content" : { - "application/problem+json" : { - "example" : [ ] - } - } - } - } - } - } - } - } - } - }, - "/actuator/info" : { - "get" : { - "tags" : [ "Actuator" ], - "summary" : "Actuator web endpoint 'info'", - "operationId" : "info", - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "application/vnd.spring-boot.actuator.v3+json" : { - "schema" : { - "type" : "object" - } - }, - "application/json" : { - "schema" : { - "type" : "object" - } - }, - "application/vnd.spring-boot.actuator.v2+json" : { - "schema" : { - "type" : "object" - } - } - } - } - }, - "x-internal" : true - } - }, - "/status" : { - "get" : { - "tags" : [ "Health Check" ], - "description" : "Returns status and statistics of this service", - "operationId" : "getStatusV1", - "responses" : { - "200" : { - "description" : "OK - Service is living", - "content" : { - "*/*" : { - "schema" : { - "type" : "string" - } - } - } - } - } - } - }, - "/a1-policy/v2/policy-types/{policytype_id}" : { - "get" : { - "tags" : [ "A1 Policy Management" ], - "description" : "Returns a policy type definition", - "operationId" : "getPolicyTypeDefinition", - "parameters" : [ { - "name" : "policytype_id", - "in" : "path", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "OK - schema of the given policy type", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/policy_type_definition" - }, - "examples" : { - "policy_type_definition" : { - "$ref" : "#/components/examples/policy_type_definition" - } - } - } - } - }, - "404" : { - "description" : "Not Found", - "content" : { - "application/problem+json" : { - "example" : [ ] - } - } - } - } - } - }, - "/actuator/logfile" : { - "get" : { - "tags" : [ "Actuator" ], - "summary" : "Actuator web endpoint 'logfile'", - "operationId" : "logfile", - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "text/plain;charset=UTF-8" : { - "schema" : { - "type" : "object" - } - } - } - } - }, - "x-internal" : true - } - }, - "/actuator/health" : { - "get" : { - "tags" : [ "Actuator" ], - "summary" : "Actuator web endpoint 'health'", - "operationId" : "health", - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "application/vnd.spring-boot.actuator.v3+json" : { - "schema" : { - "type" : "object" - } - }, - "application/json" : { - "schema" : { - "type" : "object" - } - }, - "application/vnd.spring-boot.actuator.v2+json" : { - "schema" : { - "type" : "object" - } - } - } - } - }, - "x-internal" : true - } - }, - "/a1-policy/v2/policies" : { - "get" : { - "tags" : [ "A1 Policy Management" ], - "summary" : "Query policy identities", - "description" : "Returns a list of A1 policies matching given search criteria.
If several query parameters are defined, the policies matching all conditions are returned.", - "operationId" : "getPolicyIds", - "parameters" : [ { - "name" : "policytype_id", - "in" : "query", - "description" : "Select policies of a given policy type identity.", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "string" - } - }, { - "name" : "ric_id", - "in" : "query", - "description" : "Select policies of a given Near-RT RIC identity.", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "string" - } - }, { - "name" : "service_id", - "in" : "query", - "description" : "Select policies owned by a given service.", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "string" - } - }, { - "name" : "type_name", - "in" : "query", - "description" : "Select policies of types with the given type name (type identity has the format )", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "OK - Policy identities", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/policy_id_list" - }, - "examples" : { - "policy_id_list" : { - "$ref" : "#/components/examples/policy_id_list" - } - } - } - } - }, - "404" : { - "description" : "Not Found", - "content" : { - "application/problem+json" : { - "example" : [ ] - } - } - } - } - }, - "put" : { - "tags" : [ "A1 Policy Management" ], - "description" : "Create or update a policy", - "operationId" : "putPolicy", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/policy_info" - } - } - }, - "required" : true - }, - "responses" : { - "200" : { - "description" : "OK - Policy updated", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/void" - } - } - } - }, - "201" : { - "description" : "Created - Policy created", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/void" - } - } - } - }, - "423" : { - "description" : "Locked - HTTP Status code which can be used when the state is Locked", - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/error_information" - }, - "example" : { - "status" : 423, - "title" : "Locked", - "detail" : "Requested resource is in a locked state." - } - } - } - } - } - } - }, - "/a1-policy/v2/services/{service_id}" : { - "delete" : { - "tags" : [ "Service Registry and Supervision" ], - "description" : "Unregister a service", - "operationId" : "deleteService", - "parameters" : [ { - "name" : "service_id", - "in" : "path", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "204" : { - "description" : "No Content - Service unregistered", - "content" : { - "*/*" : { - "schema" : { - "type" : "object" - } - } - } - }, - "404" : { - "description" : "Not Found", - "content" : { - "application/problem+json" : { - "example" : [ ] - } - } - } - } - } - }, - "/actuator/heapdump" : { - "get" : { - "tags" : [ "Actuator" ], - "summary" : "Actuator web endpoint 'heapdump'", - "operationId" : "heapdump", - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "application/octet-stream" : { - "schema" : { - "type" : "object" - } - } - } - } - }, - "x-internal" : true - } - }, - "/a1-policy/v2/policies/{policy_id}/status" : { - "get" : { - "tags" : [ "A1 Policy Management" ], - "description" : "Returns a policy status", - "operationId" : "getPolicyStatus", - "parameters" : [ { - "name" : "policy_id", - "in" : "path", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "OK - Policy status", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/policy_status_info" - }, - "examples" : { - "policy_status_info" : { - "$ref" : "#/components/examples/policy_status_info" - } - } - } - } - }, - "404" : { - "description" : "Not Found", - "content" : { - "application/problem+json" : { - "example" : [ ] - } - } - } - } - } - } - }, - "components" : { - "schemas" : { - "policy_type_definition" : { - "type" : "object", - "properties" : { - "policy_schema" : { - "type" : "object", - "description" : "Policy type json schema. The schema is a json object following http://json-schema.org/draft-07/schema" - } - }, - "description" : "Contains policy type schema definition" - }, - "error_information" : { - "type" : "object", - "properties" : { - "detail" : { - "type" : "string", - "description" : " A human-readable explanation specific to this occurrence of the problem.", - "example" : "Policy type not found" - }, - "title" : { - "type" : "string", - "description" : "A specific error name", - "example" : "Not Found" - }, - "status" : { - "type" : "integer", - "description" : "The HTTP status code generated by the origin server for this occurrence of the problem. ", - "format" : "int32", - "example" : 404 - } - }, - "description" : "Problem as defined in https://tools.ietf.org/html/rfc7807" - }, - "void" : { - "type" : "object", - "description" : "Void/empty" - }, - "status_info" : { - "type" : "object", - "properties" : { - "status" : { - "type" : "string", - "description" : "status text" - } - } - }, - "authorization_result" : { - "required" : [ "result" ], - "type" : "object", - "properties" : { - "result" : { - "type" : "boolean", - "description" : "If true, the access is granted" - } - }, - "description" : "Result of authorization", - "example" : { - "result" : true - } - }, - "ric_info" : { - "type" : "object", - "properties" : { - "ric_id" : { - "type" : "string", - "description" : "identity of the Near-RT RIC" - }, - "managed_element_ids" : { - "type" : "array", - "description" : "O1 identities for managed entities", - "items" : { - "type" : "string", - "description" : "O1 identities for managed entities" - } - }, - "state" : { - "type" : "string", - "description" : "Represents the states for a Near-RT RIC", - "enum" : [ "UNAVAILABLE", "AVAILABLE", "SYNCHRONIZING", "CONSISTENCY_CHECK" ] - }, - "policytype_ids" : { - "type" : "array", - "description" : "supported policy types", - "items" : { - "type" : "string", - "description" : "supported policy types" - } - } - }, - "description" : "Information for a Near-RT RIC" - }, - "service_registration_info" : { - "required" : [ "service_id" ], - "type" : "object", - "properties" : { - "callback_url" : { - "type" : "string", - "description" : "callback for notifying of Near-RT RIC state changes" - }, - "service_id" : { - "type" : "string", - "description" : "identity of the service" - }, - "keep_alive_interval_seconds" : { - "type" : "integer", - "description" : "keep alive interval for the service. This is used to enable optional heartbeat supervision of the service. If set (> 0) the registered service should regularly invoke a 'keepalive' REST call. When a service fails to invoke this 'keepalive' call within the configured time, the service is considered unavailable. An unavailable service will be automatically deregistered and its policies will be deleted. Value 0 means timeout supervision is disabled.", - "format" : "int64" - } - }, - "description" : "Information for one service" - }, - "policy_info_list" : { - "type" : "object", - "properties" : { - "policies" : { - "type" : "array", - "description" : "List of policy information", - "items" : { - "$ref" : "#/components/schemas/policy_info" - } - } - }, - "description" : "List of policy information" - }, - "policy_status_info" : { - "type" : "object", - "properties" : { - "last_modified" : { - "type" : "string", - "description" : "timestamp, last modification time" - }, - "status" : { - "type" : "object", - "description" : "the Policy status" - } - }, - "description" : "Status for one A1-P Policy" - }, - "service_status" : { - "type" : "object", - "properties" : { - "callback_url" : { - "type" : "string", - "description" : "callback for notifying of RIC synchronization" - }, - "service_id" : { - "type" : "string", - "description" : "identity of the service" - }, - "keep_alive_interval_seconds" : { - "type" : "integer", - "description" : "policy keep alive timeout", - "format" : "int64" - }, - "time_since_last_activity_seconds" : { - "type" : "integer", - "description" : "time since last invocation by the service", - "format" : "int64" - } - } - }, - "ric_info_list" : { - "type" : "object", - "properties" : { - "rics" : { - "type" : "array", - "description" : "List of Near-RT RIC information", - "items" : { - "$ref" : "#/components/schemas/ric_info" - } - } - }, - "description" : "List of Near-RT RIC information" - }, - "input" : { - "required" : [ "access_type", "auth_token", "policy_type_id" ], - "type" : "object", - "properties" : { - "access_type" : { - "type" : "string", - "description" : "Access type", - "enum" : [ "READ", "WRITE", "DELETE" ] - }, - "auth_token" : { - "type" : "string", - "description" : "Authorization token" - }, - "policy_type_id" : { - "type" : "string", - "description" : "Policy type identifier" - } - }, - "description" : "input" - }, - "policy_authorization" : { - "required" : [ "input" ], - "type" : "object", - "properties" : { - "input" : { - "$ref" : "#/components/schemas/input" - } - }, - "description" : "Authorization request for A1 policy requests" - }, - "policy_type_id_list" : { - "type" : "object", - "properties" : { - "policytype_ids" : { - "type" : "array", - "description" : "Policy type identities", - "items" : { - "type" : "string", - "description" : "Policy type identities" - } - } - }, - "description" : "Information about policy types" - }, - "policy_info" : { - "required" : [ "policy_data", "policy_id", "policytype_id", "ric_id" ], - "type" : "object", - "properties" : { - "ric_id" : { - "type" : "string", - "description" : "identity of the target Near-RT RIC" - }, - "policy_id" : { - "type" : "string", - "description" : "identity of the policy" - }, - "transient" : { - "type" : "boolean", - "description" : "if true, the policy is deleted at RIC restart. If false, its value is maintained by this service until explicitly deleted. Default false.", - "nullable" : false, - "example" : false, - "default" : false - }, - "service_id" : { - "type" : "string", - "description" : "the identity of the service owning the policy. This can be used to group the policies (it is possible to get all policies associated to a service). Note that the service does not need to be registered.", - "default" : "" - }, - "policy_data" : { - "type" : "object", - "description" : "the configuration of the policy" - }, - "status_notification_uri" : { - "type" : "string", - "description" : "Callback URI for policy status updates" - }, - "policytype_id" : { - "type" : "string", - "description" : "identity of the policy type" - } - }, - "description" : "Information for one A1-P Policy" - }, - "policy_id_list" : { - "type" : "object", - "properties" : { - "policy_ids" : { - "type" : "array", - "description" : "Policy identities", - "items" : { - "type" : "string", - "description" : "Policy identities" - } - } - }, - "description" : "A list of policy identities", - "example" : { - "policy_ids" : [ "policy_ids", "policy_ids" ] - } - }, - "service_status_list" : { - "type" : "object", - "properties" : { - "service_list" : { - "type" : "array", - "description" : "List of service information", - "items" : { - "$ref" : "#/components/schemas/service_status" - } - } - } - }, - "service_callback_info_v2" : { - "required" : [ "event_type", "ric_id" ], - "type" : "object", - "properties" : { - "ric_id" : { - "type" : "string", - "description" : "identity of a Near-RT RIC" - }, - "event_type" : { - "type" : "string", - "description" : "values:\nAVAILABLE: the Near-RT RIC has become available for A1 Policy management", - "enum" : [ "AVAILABLE" ] - } - }, - "description" : "Information transferred as in Service callbacks (callback_url)" - }, - "Link" : { - "type" : "object", - "properties" : { - "templated" : { - "type" : "boolean" - }, - "href" : { - "type" : "string" - } - } - } - }, - "responses" : { - "Locked" : { - "description" : "Locked - HTTP Status code which can be used when the state is Locked", - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/error_information" - }, - "example" : { - "status" : 423, - "title" : "Locked", - "detail" : "Requested resource is in a locked state." - } - } - } - }, - "BadRequest" : { - "description" : "Bad Request", - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/error_information" - }, - "example" : { - "status" : 400, - "title" : "Bad Request", - "detail" : "The provided request is not valid." - } - } - } - }, - "Forbidden" : { - "description" : "Forbidden", - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/error_information" - }, - "example" : { - "status" : 403, - "title" : "Forbidden", - "detail" : "Your role does not allow to perform this action. Contact System Administrator to change your access rights." - } - } - } - }, - "NotFound" : { - "description" : "Not Found", - "content" : { - "application/problem+json" : { - "example" : [ ] - } - } - } - }, - "examples" : { - "service_status" : { - "description" : "List of service information", - "value" : { - "callback_url" : "callback_url", - "service_id" : "service_id", - "keep_alive_interval_seconds" : 0, - "time_since_last_activity_seconds" : 6 - } - }, - "service_status_list" : { - "description" : "List of service information", - "value" : { - "service_list" : [ { - "callback_url" : "callback_url", - "service_id" : "service_id", - "keep_alive_interval_seconds" : 0, - "time_since_last_activity_seconds" : 6 - }, { - "callback_url" : "callback_url", - "service_id" : "service_id", - "keep_alive_interval_seconds" : 0, - "time_since_last_activity_seconds" : 6 - } ] - } - }, - "policy_type_definition" : { - "description" : "Schema of the given Policy type", - "value" : { - "policy_schema" : "{}" - } - }, - "policy_type_id_list" : { - "description" : "Array of policy type id's", - "value" : { - "policy_type_id_list" : [ "policytype_id", "policytype_id" ] - } - }, - "policy_info" : { - "description" : "Policy information of one A1-P policy", - "value" : { - "ric_id" : "ric_id", - "policy_id" : "policy_id", - "transient" : false, - "service_id" : "service_id", - "policy_data" : "{}", - "status_notification_uri" : "status_notification_uri", - "policytype_id" : "policytype_id" - } - }, - "policy_info_list" : { - "description" : "List of policy information", - "value" : { - "policies" : [ { - "ric_id" : "ric_id", - "policy_id" : "policy_id", - "transient" : false, - "service_id" : "service_id", - "policy_data" : "{}", - "status_notification_uri" : "status_notification_uri", - "policytype_id" : "policytype_id" - }, { - "ric_id" : "ric_id", - "policy_id" : "policy_id", - "transient" : false, - "service_id" : "service_id", - "policy_data" : "{}", - "status_notification_uri" : "status_notification_uri", - "policytype_id" : "policytype_id" - } ] - } - }, - "policy_id_list" : { - "description" : "A list of policy identities", - "value" : { - "policy_ids" : [ "some_policy_id", "some_policy_id" ] - } - }, - "policy_status_info" : { - "description" : "Status for one A1-P Policy", - "value" : { - "last_modified" : "last_modified", - "status" : { - "value" : { - "status" : "status" - } - } - } - }, - "status_info" : { - "value" : { - "status" : "status" - } - }, - "ric_info" : { - "value" : { - "ric_id" : "ric_id", - "managed_element_ids" : [ "some_managed_element_id", "some_managed_element_id" ], - "state" : "UNAVAILABLE", - "policytype_ids" : [ "some_policytype_id", "some_policytype_id" ] - } - }, - "ric_info_list" : { - "value" : { - "rics" : [ { - "ric_id" : "ric_id", - "managed_element_ids" : [ "some_managed_element_id", "some_managed_element_id" ], - "state" : "UNAVAILABLE", - "policytype_ids" : [ "policytype_id", "policytype_id" ] - }, { - "ric_id" : "ric_id", - "managed_element_ids" : [ "managed_element_ids", "managed_element_ids" ], - "state" : "UNAVAILABLE", - "policytype_ids" : [ "policytype_ids", "policytype_ids" ] - } ] - } - } - } - } +{ + "openapi" : "3.0.3", + "info" : { + "contact" : { + "email" : "discuss-list@onap.com", + "url" : "https://www.onap.org/" + }, + "description" : "

General

The O-RAN Non-RT RIC Policy Management Service provides a REST API for managemecnt of A1 policies.
The main tasks of the service are:

A1 Policy creation, modification and deletion.
Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs
Maintaining a view of supported Near-RT RIC policy types
Supervision of using services (R-APPs). When a service is unavailable, its policies are removed.

APIs provided or defined by the service

A1 Policy Management

This is an API for management of A1 Policies.

A1 Policy retrieval, creation, modification and deletion.
Retrieval of supported A1 Policy types for a Near-RT RIC
Retrieval of status for existing A1 policies

Management of configuration

API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.

Service callbacks

These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.

NearRT-RIC Repository

This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted for one Near-RT RIC.

Health Check

API used for supervision of the PMS component.

Service Registry and Supervision

Authorization API

API used for access control of A1 Policy access. If configured, an external authorization provider is requested to grant access to the A1 Policy type.

Spring Boot Actuator

Provides generic functions used to monitor and manage the Spring web application.

Get callbacks about available NearRT RICs.
Activate supervision of the service. If a service is inactive, its policies will automatically be deleted.

Policies can be created even if the service is not registerred. This is a feature which it is optional to use.", + "operationId" : "putService", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/service_registration_info" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "*/*" : { + "schema" : { + "type" : "object" + } + } + }, + "description" : "OK - Service updated" + }, + "201" : { + "content" : { + "*/*" : { + "schema" : { + "type" : "object" + } + } + }, + "description" : "Created - Service created" + }, + "400" : { + "content" : { + "application/problem+json" : { + "example" : { + "status" : 400, + "title" : "Bad Request", + "detail" : "The provided request is not valid." + }, + "schema" : { + "$ref" : "#/components/schemas/error_information" + } + } + }, + "description" : "Bad Request" + } + }, + "summary" : "Register a service", + "tags" : [ "Service Registry and Supervision" ] + } + }, + "/actuator/info" : { + "get" : { + "operationId" : "info", + "responses" : { + "200" : { + "content" : { + "application/vnd.spring-boot.actuator.v3+json" : { + "schema" : { + "type" : "object" + } + }, + "application/json" : { + "schema" : { + "type" : "object" + } + }, + "application/vnd.spring-boot.actuator.v2+json" : { + "schema" : { + "type" : "object" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Actuator web endpoint 'info'", + "tags" : [ "Actuator" ], + "x-internal" : true + } + }, + "/status" : { + "get" : { + "description" : "Returns status and statistics of this service", + "operationId" : "getStatusV1", + "responses" : { + "200" : { + "content" : { + "*/*" : { + "schema" : { + "type" : "string" + } + } + }, + "description" : "OK - Service is living" + } + }, + "tags" : [ "Health Check" ] + } + }, + "/a1-policy/v2/policy-types/{policytype_id}" : { + "get" : { + "description" : "Returns a policy type definition", + "operationId" : "getPolicyTypeDefinition", + "parameters" : [ { + "explode" : false, + "in" : "path", + "name" : "policytype_id", + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "policy_type_definition" : { + "$ref" : "#/components/examples/policy_type_definition" + } + }, + "schema" : { + "$ref" : "#/components/schemas/policy_type_definition" + } + } + }, + "description" : "OK - schema of the given policy type" + }, + "404" : { + "content" : { + "application/problem+json" : { + "example" : [ ] + } + }, + "description" : "Not Found" + } + }, + "tags" : [ "A1 Policy Management" ] + } + }, + "/actuator/logfile" : { + "get" : { + "operationId" : "logfile", + "responses" : { + "200" : { + "content" : { + "text/plain;charset=UTF-8" : { + "schema" : { + "type" : "object" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Actuator web endpoint 'logfile'", + "tags" : [ "Actuator" ], + "x-internal" : true + } + }, + "/actuator/health" : { + "get" : { + "operationId" : "health", + "responses" : { + "200" : { + "content" : { + "application/vnd.spring-boot.actuator.v3+json" : { + "schema" : { + "type" : "object" + } + }, + "application/json" : { + "schema" : { + "type" : "object" + } + }, + "application/vnd.spring-boot.actuator.v2+json" : { + "schema" : { + "type" : "object" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Actuator web endpoint 'health'", + "tags" : [ "Actuator" ], + "x-internal" : true + } + }, + "/a1-policy/v2/policies" : { + "get" : { + "description" : "Returns a list of A1 policies matching given search criteria.
If several query parameters are defined, the policies matching all conditions are returned.", + "operationId" : "getPolicyIds", + "parameters" : [ { + "description" : "Select policies of a given policy type identity.", + "explode" : true, + "in" : "query", + "name" : "policytype_id", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + }, { + "description" : "Select policies of a given Near-RT RIC identity.", + "explode" : true, + "in" : "query", + "name" : "ric_id", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + }, { + "description" : "Select policies owned by a given service.", + "explode" : true, + "in" : "query", + "name" : "service_id", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + }, { + "description" : "Select policies of types with the given type name (type identity has the format )", + "explode" : true, + "in" : "query", + "name" : "type_name", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "policy_id_list" : { + "$ref" : "#/components/examples/policy_id_list" + } + }, + "schema" : { + "$ref" : "#/components/schemas/policy_id_list" + } + } + }, + "description" : "OK - Policy identities" + }, + "404" : { + "content" : { + "application/problem+json" : { + "example" : [ ] + } + }, + "description" : "Not Found" + } + }, + "summary" : "Query policy identities", + "tags" : [ "A1 Policy Management" ] + }, + "put" : { + "description" : "Create or update a policy", + "operationId" : "putPolicy", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/policy_info" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/void" + } + } + }, + "description" : "OK - Policy updated" + }, + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/void" + } + } + }, + "description" : "Created - Policy created" + }, + "423" : { + "content" : { + "application/problem+json" : { + "example" : { + "status" : 423, + "title" : "Locked", + "detail" : "Requested resource is in a locked state." + }, + "schema" : { + "$ref" : "#/components/schemas/error_information" + } + } + }, + "description" : "Locked - HTTP Status code which can be used when the state is Locked" + } + }, + "tags" : [ "A1 Policy Management" ] + } + }, + "/a1-policy/v2/services/{service_id}" : { + "delete" : { + "description" : "Unregister a service", + "operationId" : "deleteService", + "parameters" : [ { + "explode" : false, + "in" : "path", + "name" : "service_id", + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } ], + "responses" : { + "204" : { + "content" : { + "*/*" : { + "schema" : { + "type" : "object" + } + } + }, + "description" : "No Content - Service unregistered" + }, + "404" : { + "content" : { + "application/problem+json" : { + "example" : [ ] + } + }, + "description" : "Not Found" + } + }, + "tags" : [ "Service Registry and Supervision" ] + } + }, + "/actuator/heapdump" : { + "get" : { + "operationId" : "heapdump", + "responses" : { + "200" : { + "content" : { + "application/octet-stream" : { + "schema" : { + "type" : "object" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Actuator web endpoint 'heapdump'", + "tags" : [ "Actuator" ], + "x-internal" : true + } + }, + "/a1-policy/v2/policies/{policy_id}/status" : { + "get" : { + "description" : "Returns a policy status", + "operationId" : "getPolicyStatus", + "parameters" : [ { + "explode" : false, + "in" : "path", + "name" : "policy_id", + "required" : true, + "schema" : { + "type" : "string" + }, + "style" : "simple" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "policy_status_info" : { + "$ref" : "#/components/examples/policy_status_info" + } + }, + "schema" : { + "$ref" : "#/components/schemas/policy_status_info" + } + } + }, + "description" : "OK - Policy status" + }, + "404" : { + "content" : { + "application/problem+json" : { + "example" : [ ] + } + }, + "description" : "Not Found" + } + }, + "tags" : [ "A1 Policy Management" ] + } + } + }, + "components" : { + "examples" : { + "service_status" : { + "description" : "List of service information", + "value" : { + "callback_url" : "callback_url", + "service_id" : "service_id", + "keep_alive_interval_seconds" : 0, + "time_since_last_activity_seconds" : 6 + } + }, + "service_status_list" : { + "description" : "List of service information", + "value" : { + "service_list" : [ { + "callback_url" : "callback_url", + "service_id" : "service_id", + "keep_alive_interval_seconds" : 0, + "time_since_last_activity_seconds" : 6 + }, { + "callback_url" : "callback_url", + "service_id" : "service_id", + "keep_alive_interval_seconds" : 0, + "time_since_last_activity_seconds" : 6 + } ] + } + }, + "policy_type_definition" : { + "description" : "Schema of the given Policy type", + "value" : { + "policy_schema" : "{}" + } + }, + "policy_type_id_list" : { + "description" : "Array of policy type id's", + "value" : { + "policy_type_id_list" : [ "policytype_id", "policytype_id" ] + } + }, + "policy_info" : { + "description" : "Policy information of one A1-P policy", + "value" : { + "ric_id" : "ric_id", + "policy_id" : "policy_id", + "transient" : false, + "service_id" : "service_id", + "policy_data" : "{}", + "status_notification_uri" : "status_notification_uri", + "policytype_id" : "policytype_id" + } + }, + "policy_info_list" : { + "description" : "List of policy information", + "value" : { + "policies" : [ { + "ric_id" : "ric_id", + "policy_id" : "policy_id", + "transient" : false, + "service_id" : "service_id", + "policy_data" : "{}", + "status_notification_uri" : "status_notification_uri", + "policytype_id" : "policytype_id" + }, { + "ric_id" : "ric_id", + "policy_id" : "policy_id", + "transient" : false, + "service_id" : "service_id", + "policy_data" : "{}", + "status_notification_uri" : "status_notification_uri", + "policytype_id" : "policytype_id" + } ] + } + }, + "policy_id_list" : { + "description" : "A list of policy identities", + "value" : { + "policy_ids" : [ "some_policy_id", "some_policy_id" ] + } + }, + "policy_status_info" : { + "description" : "Status for one A1-P Policy", + "value" : { + "last_modified" : "last_modified", + "status" : { + "value" : { + "status" : "status" + } + } + } + }, + "status_info" : { + "value" : { + "status" : "status" + } + }, + "ric_info" : { + "value" : { + "ric_id" : "ric_id", + "managed_element_ids" : [ "some_managed_element_id", "some_managed_element_id" ], + "state" : "UNAVAILABLE", + "policytype_ids" : [ "some_policytype_id", "some_policytype_id" ] + } + }, + "ric_info_list" : { + "value" : { + "rics" : [ { + "ric_id" : "ric_id", + "managed_element_ids" : [ "some_managed_element_id", "some_managed_element_id" ], + "state" : "UNAVAILABLE", + "policytype_ids" : [ "policytype_id", "policytype_id" ] + }, { + "ric_id" : "ric_id", + "managed_element_ids" : [ "managed_element_ids", "managed_element_ids" ], + "state" : "UNAVAILABLE", + "policytype_ids" : [ "policytype_ids", "policytype_ids" ] + } ] + } + } + }, + "responses" : { + "Locked" : { + "content" : { + "application/problem+json" : { + "example" : { + "status" : 423, + "title" : "Locked", + "detail" : "Requested resource is in a locked state." + }, + "schema" : { + "$ref" : "#/components/schemas/error_information" + } + } + }, + "description" : "Locked - HTTP Status code which can be used when the state is Locked" + }, + "BadRequest" : { + "content" : { + "application/problem+json" : { + "example" : { + "status" : 400, + "title" : "Bad Request", + "detail" : "The provided request is not valid." + }, + "schema" : { + "$ref" : "#/components/schemas/error_information" + } + } + }, + "description" : "Bad Request" + }, + "Forbidden" : { + "content" : { + "application/problem+json" : { + "example" : { + "status" : 403, + "title" : "Forbidden", + "detail" : "Your role does not allow to perform this action. Contact System Administrator to change your access rights." + }, + "schema" : { + "$ref" : "#/components/schemas/error_information" + } + } + }, + "description" : "Forbidden" + }, + "NotFound" : { + "content" : { + "application/problem+json" : { + "example" : [ ] + } + }, + "description" : "Not Found" + } + }, + "schemas" : { + "policy_type_definition" : { + "description" : "Contains policy type schema definition", + "properties" : { + "policy_schema" : { + "description" : "Policy type json schema. The schema is a json object following http://json-schema.org/draft-07/schema", + "type" : "object" + } + }, + "type" : "object" + }, + "error_information" : { + "description" : "Problem as defined in https://tools.ietf.org/html/rfc7807", + "properties" : { + "detail" : { + "description" : " A human-readable explanation specific to this occurrence of the problem.", + "example" : "Policy type not found", + "type" : "string" + }, + "title" : { + "description" : "A specific error name", + "example" : "Not Found", + "type" : "string" + }, + "status" : { + "description" : "The HTTP status code generated by the origin server for this occurrence of the problem. ", + "example" : 404, + "format" : "int32", + "type" : "integer" + } + }, + "type" : "object" + }, + "void" : { + "description" : "Void/empty", + "type" : "object" + }, + "status_info" : { + "properties" : { + "status" : { + "description" : "status text", + "type" : "string" + } + }, + "type" : "object" + }, + "authorization_result" : { + "description" : "Result of authorization", + "example" : { + "result" : true + }, + "properties" : { + "result" : { + "description" : "If true, the access is granted", + "type" : "boolean" + } + }, + "required" : [ "result" ], + "type" : "object" + }, + "ric_info" : { + "description" : "Information for a Near-RT RIC", + "properties" : { + "ric_id" : { + "description" : "identity of the Near-RT RIC", + "type" : "string" + }, + "managed_element_ids" : { + "description" : "O1 identities for managed entities", + "items" : { + "description" : "O1 identities for managed entities", + "type" : "string" + }, + "type" : "array" + }, + "state" : { + "description" : "Represents the states for a Near-RT RIC", + "enum" : [ "UNAVAILABLE", "AVAILABLE", "SYNCHRONIZING", "CONSISTENCY_CHECK" ], + "type" : "string" + }, + "policytype_ids" : { + "description" : "supported policy types", + "items" : { + "description" : "supported policy types", + "type" : "string" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "service_registration_info" : { + "description" : "Information for one service", + "properties" : { + "callback_url" : { + "description" : "callback for notifying of Near-RT RIC state changes", + "type" : "string" + }, + "service_id" : { + "description" : "identity of the service", + "type" : "string" + }, + "keep_alive_interval_seconds" : { + "description" : "keep alive interval for the service. This is used to enable optional heartbeat supervision of the service. If set (> 0) the registered service should regularly invoke a 'keepalive' REST call. When a service fails to invoke this 'keepalive' call within the configured time, the service is considered unavailable. An unavailable service will be automatically deregistered and its policies will be deleted. Value 0 means timeout supervision is disabled.", + "format" : "int64", + "type" : "integer" + } + }, + "required" : [ "service_id" ], + "type" : "object" + }, + "policy_info_list" : { + "description" : "List of policy information", + "properties" : { + "policies" : { + "description" : "List of policy information", + "items" : { + "$ref" : "#/components/schemas/policy_info" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "policy_status_info" : { + "description" : "Status for one A1-P Policy", + "properties" : { + "last_modified" : { + "description" : "timestamp, last modification time", + "type" : "string" + }, + "status" : { + "description" : "the Policy status", + "type" : "object" + } + }, + "type" : "object" + }, + "service_status" : { + "properties" : { + "callback_url" : { + "description" : "callback for notifying of RIC synchronization", + "type" : "string" + }, + "service_id" : { + "description" : "identity of the service", + "type" : "string" + }, + "keep_alive_interval_seconds" : { + "description" : "policy keep alive timeout", + "format" : "int64", + "type" : "integer" + }, + "time_since_last_activity_seconds" : { + "description" : "time since last invocation by the service", + "format" : "int64", + "type" : "integer" + } + }, + "type" : "object" + }, + "ric_info_list" : { + "description" : "List of Near-RT RIC information", + "properties" : { + "rics" : { + "description" : "List of Near-RT RIC information", + "items" : { + "$ref" : "#/components/schemas/ric_info" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "input" : { + "description" : "input", + "properties" : { + "access_type" : { + "description" : "Access type", + "enum" : [ "READ", "WRITE", "DELETE" ], + "type" : "string" + }, + "auth_token" : { + "description" : "Authorization token", + "type" : "string" + }, + "policy_type_id" : { + "description" : "Policy type identifier", + "type" : "string" + } + }, + "required" : [ "access_type", "auth_token", "policy_type_id" ], + "type" : "object" + }, + "policy_authorization" : { + "description" : "Authorization request for A1 policy requests", + "properties" : { + "input" : { + "$ref" : "#/components/schemas/input" + } + }, + "required" : [ "input" ], + "type" : "object" + }, + "policy_type_id_list" : { + "description" : "Information about policy types", + "properties" : { + "policytype_ids" : { + "description" : "Policy type identities", + "items" : { + "description" : "Policy type identities", + "type" : "string" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "policy_info" : { + "description" : "Information for one A1-P Policy", + "properties" : { + "ric_id" : { + "description" : "identity of the target Near-RT RIC", + "type" : "string" + }, + "policy_id" : { + "description" : "identity of the policy", + "type" : "string" + }, + "transient" : { + "default" : false, + "description" : "if true, the policy is deleted at RIC restart. If false, its value is maintained by this service until explicitly deleted. Default false.", + "example" : false, + "nullable" : false, + "type" : "boolean" + }, + "service_id" : { + "default" : "", + "description" : "the identity of the service owning the policy. This can be used to group the policies (it is possible to get all policies associated to a service). Note that the service does not need to be registered.", + "type" : "string" + }, + "policy_data" : { + "description" : "the configuration of the policy", + "type" : "object" + }, + "status_notification_uri" : { + "description" : "Callback URI for policy status updates", + "type" : "string" + }, + "policytype_id" : { + "description" : "identity of the policy type", + "type" : "string" + } + }, + "required" : [ "policy_data", "policy_id", "policytype_id", "ric_id" ], + "type" : "object" + }, + "policy_id_list" : { + "description" : "A list of policy identities", + "example" : { + "policy_ids" : [ "policy_ids", "policy_ids" ] + }, + "properties" : { + "policy_ids" : { + "description" : "Policy identities", + "items" : { + "description" : "Policy identities", + "type" : "string" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "service_status_list" : { + "properties" : { + "service_list" : { + "description" : "List of service information", + "items" : { + "$ref" : "#/components/schemas/service_status" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "service_callback_info_v2" : { + "description" : "Information transferred as in Service callbacks (callback_url)", + "properties" : { + "ric_id" : { + "description" : "identity of a Near-RT RIC", + "type" : "string" + }, + "event_type" : { + "description" : "values:\nAVAILABLE: the Near-RT RIC has become available for A1 Policy management", + "enum" : [ "AVAILABLE" ], + "type" : "string" + } + }, + "required" : [ "event_type", "ric_id" ], + "type" : "object" + }, + "Link" : { + "properties" : { + "templated" : { + "type" : "boolean" + }, + "href" : { + "type" : "string" + } + }, + "type" : "object" + } + } + } } \ No newline at end of file diff --git a/docs/offeredapis/swagger/pms-api.yaml b/docs/offeredapis/swagger/pms-api.yaml index 1c25e051..c0b50d4d 100644 --- a/docs/offeredapis/swagger/pms-api.yaml +++ b/docs/offeredapis/swagger/pms-api.yaml @@ -431,7 +431,6 @@ paths: - Actuator /a1-policy/v2/configuration: get: - x-internal: true operationId: getConfiguration responses: "200": @@ -447,7 +446,6 @@ paths: tags: - Configuration put: - x-internal: true operationId: putConfiguration requestBody: content: