X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;ds=sidebyside;f=docs%2Fopenapi%2FEvents.html;fp=docs%2Fopenapi%2FEvents.html;h=e0249668ccebbf26a2e80273b8229b736662773e;hb=c9c21982005e56bc3cee0e764d8ee6e5a4cc102b;hp=0000000000000000000000000000000000000000;hpb=e5c291cf738d966d1f94e66c0d675ee42fad5067;p=nonrtric%2Fplt%2Fsme.git diff --git a/docs/openapi/Events.html b/docs/openapi/Events.html new file mode 100644 index 0000000..e024966 --- /dev/null +++ b/docs/openapi/Events.html @@ -0,0 +1,6241 @@ + + + + + CAPIF_Events_API + + + + + + + + + + + + + + + + + +
+
+ +
+
+
+

CAPIF_Events_API

+
+
+
+ +
+
+

Default

+
+
+
+

subscriberIdSubscriptionsPost

+

+
+
+
+

+

Creates a new individual CAPIF Event Subscription.

+

+
+
/{subscriberId}/subscriptions
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X POST \
+ -H "Accept: application/json,application/problem+json" \
+ -H "Content-Type: application/json" \
+ "https://example.com/capif-events/v1/{subscriberId}/subscriptions" \
+ -d '{
+  "notificationDestination" : "notificationDestination",
+  "eventFilters" : [ {
+    "aefIds" : [ "aefIds", "aefIds" ],
+    "apiInvokerIds" : [ "apiInvokerIds", "apiInvokerIds" ],
+    "apiIds" : [ "apiIds", "apiIds" ]
+  }, {
+    "aefIds" : [ "aefIds", "aefIds" ],
+    "apiInvokerIds" : [ "apiInvokerIds", "apiInvokerIds" ],
+    "apiIds" : [ "apiIds", "apiIds" ]
+  } ],
+  "supportedFeatures" : "supportedFeatures",
+  "eventReq" : {
+    "grpRepTime" : 0,
+    "partitionCriteria" : [ null, null ],
+    "monDur" : "2000-01-23T04:56:07.000+00:00",
+    "immRep" : true,
+    "maxReportNbr" : 0,
+    "repPeriod" : 1,
+    "sampRatio" : 60
+  },
+  "websockNotifConfig" : {
+    "requestWebsocketUri" : true,
+    "websocketUri" : "websocketUri"
+  },
+  "events" : [ null, null ],
+  "requestTestNotification" : true
+}'
+
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        DefaultApi apiInstance = new DefaultApi();
+        String subscriberId = subscriberId_example; // String | Identifier of the Subscriber
+        EventSubscription eventSubscription = ; // EventSubscription | 
+
+        try {
+            EventSubscription result = apiInstance.subscriberIdSubscriptionsPost(subscriberId, eventSubscription);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#subscriberIdSubscriptionsPost");
+            e.printStackTrace();
+        }
+    }
+}
+
+
+ +
+
import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String subscriberId = new String(); // String | Identifier of the Subscriber
+final EventSubscription eventSubscription = new EventSubscription(); // EventSubscription | 
+
+try {
+    final result = await api_instance.subscriberIdSubscriptionsPost(subscriberId, eventSubscription);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->subscriberIdSubscriptionsPost: $e\n');
+}
+
+
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String subscriberId = subscriberId_example; // String | Identifier of the Subscriber
+        EventSubscription eventSubscription = ; // EventSubscription | 
+
+        try {
+            EventSubscription result = apiInstance.subscriberIdSubscriptionsPost(subscriberId, eventSubscription);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#subscriberIdSubscriptionsPost");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+

+
+// Create an instance of the API class
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+String *subscriberId = subscriberId_example; // Identifier of the Subscriber (default to null)
+EventSubscription *eventSubscription = ; // 
+
+[apiInstance subscriberIdSubscriptionsPostWith:subscriberId
+    eventSubscription:eventSubscription
+              completionHandler: ^(EventSubscription output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+
+
+ +
+
var CapifEventsApi = require('capif_events_api');
+
+// Create an instance of the API class
+var api = new CapifEventsApi.DefaultApi()
+var subscriberId = subscriberId_example; // {String} Identifier of the Subscriber
+var eventSubscription = ; // {EventSubscription} 
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.subscriberIdSubscriptionsPost(subscriberId, eventSubscription, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class subscriberIdSubscriptionsPostExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new DefaultApi();
+            var subscriberId = subscriberId_example;  // String | Identifier of the Subscriber (default to null)
+            var eventSubscription = new EventSubscription(); // EventSubscription | 
+
+            try {
+                EventSubscription result = apiInstance.subscriberIdSubscriptionsPost(subscriberId, eventSubscription);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling DefaultApi.subscriberIdSubscriptionsPost: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$subscriberId = subscriberId_example; // String | Identifier of the Subscriber
+$eventSubscription = ; // EventSubscription | 
+
+try {
+    $result = $api_instance->subscriberIdSubscriptionsPost($subscriberId, $eventSubscription);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->subscriberIdSubscriptionsPost: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $subscriberId = subscriberId_example; # String | Identifier of the Subscriber
+my $eventSubscription = WWW::OPenAPIClient::Object::EventSubscription->new(); # EventSubscription | 
+
+eval {
+    my $result = $api_instance->subscriberIdSubscriptionsPost(subscriberId => $subscriberId, eventSubscription => $eventSubscription);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->subscriberIdSubscriptionsPost: $@\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.DefaultApi()
+subscriberId = subscriberId_example # String | Identifier of the Subscriber (default to null)
+eventSubscription =  # EventSubscription | 
+
+try:
+    api_response = api_instance.subscriber_id_subscriptions_post(subscriberId, eventSubscription)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->subscriberIdSubscriptionsPost: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let subscriberId = subscriberId_example; // String
+    let eventSubscription = ; // EventSubscription
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.subscriberIdSubscriptionsPost(subscriberId, eventSubscription, &context).wait();
+
+    println!("{:?}", result);
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + +
NameDescription
subscriberId* + + +
+
+
+ + String + + +
+Identifier of the Subscriber +
+
+
+ Required +
+
+
+
+ + +
Body parameters
+ + + + + + + + + +
NameDescription
eventSubscription * +

+ +
+
+ + + +

Responses

+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

subscriberIdSubscriptionsSubscriptionIdDelete

+

+
+
+
+

+

Deletes an individual CAPIF Event Subscription.

+

+
+
/{subscriberId}/subscriptions/{subscriptionId}
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X DELETE \
+ -H "Accept: application/problem+json" \
+ "https://example.com/capif-events/v1/{subscriberId}/subscriptions/{subscriptionId}"
+
+
+
+
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        DefaultApi apiInstance = new DefaultApi();
+        String subscriberId = subscriberId_example; // String | Identifier of the Subscriber
+        String subscriptionId = subscriptionId_example; // String | Identifier of an individual Events Subscription
+
+        try {
+            apiInstance.subscriberIdSubscriptionsSubscriptionIdDelete(subscriberId, subscriptionId);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#subscriberIdSubscriptionsSubscriptionIdDelete");
+            e.printStackTrace();
+        }
+    }
+}
+
+
+ +
+
import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String subscriberId = new String(); // String | Identifier of the Subscriber
+final String subscriptionId = new String(); // String | Identifier of an individual Events Subscription
+
+try {
+    final result = await api_instance.subscriberIdSubscriptionsSubscriptionIdDelete(subscriberId, subscriptionId);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->subscriberIdSubscriptionsSubscriptionIdDelete: $e\n');
+}
+
+
+
+ +
+
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String subscriberId = subscriberId_example; // String | Identifier of the Subscriber
+        String subscriptionId = subscriptionId_example; // String | Identifier of an individual Events Subscription
+
+        try {
+            apiInstance.subscriberIdSubscriptionsSubscriptionIdDelete(subscriberId, subscriptionId);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#subscriberIdSubscriptionsSubscriptionIdDelete");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+

+
+// Create an instance of the API class
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+String *subscriberId = subscriberId_example; // Identifier of the Subscriber (default to null)
+String *subscriptionId = subscriptionId_example; // Identifier of an individual Events Subscription (default to null)
+
+[apiInstance subscriberIdSubscriptionsSubscriptionIdDeleteWith:subscriberId
+    subscriptionId:subscriptionId
+              completionHandler: ^(NSError* error) {
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+
+
+ +
+
var CapifEventsApi = require('capif_events_api');
+
+// Create an instance of the API class
+var api = new CapifEventsApi.DefaultApi()
+var subscriberId = subscriberId_example; // {String} Identifier of the Subscriber
+var subscriptionId = subscriptionId_example; // {String} Identifier of an individual Events Subscription
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.subscriberIdSubscriptionsSubscriptionIdDelete(subscriberId, subscriptionId, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class subscriberIdSubscriptionsSubscriptionIdDeleteExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new DefaultApi();
+            var subscriberId = subscriberId_example;  // String | Identifier of the Subscriber (default to null)
+            var subscriptionId = subscriptionId_example;  // String | Identifier of an individual Events Subscription (default to null)
+
+            try {
+                apiInstance.subscriberIdSubscriptionsSubscriptionIdDelete(subscriberId, subscriptionId);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling DefaultApi.subscriberIdSubscriptionsSubscriptionIdDelete: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$subscriberId = subscriberId_example; // String | Identifier of the Subscriber
+$subscriptionId = subscriptionId_example; // String | Identifier of an individual Events Subscription
+
+try {
+    $api_instance->subscriberIdSubscriptionsSubscriptionIdDelete($subscriberId, $subscriptionId);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->subscriberIdSubscriptionsSubscriptionIdDelete: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $subscriberId = subscriberId_example; # String | Identifier of the Subscriber
+my $subscriptionId = subscriptionId_example; # String | Identifier of an individual Events Subscription
+
+eval {
+    $api_instance->subscriberIdSubscriptionsSubscriptionIdDelete(subscriberId => $subscriberId, subscriptionId => $subscriptionId);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->subscriberIdSubscriptionsSubscriptionIdDelete: $@\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.DefaultApi()
+subscriberId = subscriberId_example # String | Identifier of the Subscriber (default to null)
+subscriptionId = subscriptionId_example # String | Identifier of an individual Events Subscription (default to null)
+
+try:
+    api_instance.subscriber_id_subscriptions_subscription_id_delete(subscriberId, subscriptionId)
+except ApiException as e:
+    print("Exception when calling DefaultApi->subscriberIdSubscriptionsSubscriptionIdDelete: %s\n" % e)
+
+ +
+
extern crate DefaultApi;
+
+pub fn main() {
+    let subscriberId = subscriberId_example; // String
+    let subscriptionId = subscriptionId_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.subscriberIdSubscriptionsSubscriptionIdDelete(subscriberId, subscriptionId, &context).wait();
+
+    println!("{:?}", result);
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + + + + + +
NameDescription
subscriberId* + + +
+
+
+ + String + + +
+Identifier of the Subscriber +
+
+
+ Required +
+
+
+
subscriptionId* + + +
+
+
+ + String + + +
+Identifier of an individual Events Subscription +
+
+
+ Required +
+
+
+
+ + + + + +

Responses

+

+

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

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

+ + + + + + +
+
+
+ +
+ +
+
+ + + + + + + + + + + + + +
NameTypeFormatDescription
LocationStringAn alternative URI of the resource.
+
+
+

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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