Topology Exposure and Inventory API

Classifiers

updateClassifier

Update entities and/or relationships with classifier(s).

Update entities and/or relationships with classifier(s).


/manage-classifiers

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/problem+json" \
 -H "Content-Type: application/json" \
 "https://localhost/topology-inventory/v1/manage-classifiers" \
 -d '{
  "classifiers" : [ "classifiers", "classifiers" ],
  "relationshipIds" : [ "relationshipIds", "relationshipIds" ],
  "operation" : "merge",
  "entityIds" : [ "entityIds", "entityIds" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ClassifiersApi;

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

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

        // Create an instance of the API class
        ClassifiersApi apiInstance = new ClassifiersApi();
        String accept = application/json; // String | 
        String contentType = application/json; // String | 
        Classifier classifier = ; // Classifier | 

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

final api_instance = DefaultApi();

final String accept = new String(); // String | 
final String contentType = new String(); // String | 
final Classifier classifier = new Classifier(); // Classifier | 

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

import org.openapitools.client.api.ClassifiersApi;

public class ClassifiersApiExample {
    public static void main(String[] args) {
        ClassifiersApi apiInstance = new ClassifiersApi();
        String accept = application/json; // String | 
        String contentType = application/json; // String | 
        Classifier classifier = ; // Classifier | 

        try {
            apiInstance.updateClassifier(accept, contentType, classifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClassifiersApi#updateClassifier");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ClassifiersApi *apiInstance = [[ClassifiersApi alloc] init];
String *accept = application/json; //  (default to application/json)
String *contentType = application/json; //  (default to application/json)
Classifier *classifier = ; // 

// Update entities and/or relationships with classifier(s).
[apiInstance updateClassifierWith:accept
    contentType:contentType
    classifier:classifier
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');

// Create an instance of the API class
var api = new TopologyExposureAndInventoryApi.ClassifiersApi()
var accept = application/json; // {String} 
var contentType = application/json; // {String} 
var classifier = ; // {Classifier} 

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

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

            // Create an instance of the API class
            var apiInstance = new ClassifiersApi();
            var accept = application/json;  // String |  (default to application/json)
            var contentType = application/json;  // String |  (default to application/json)
            var classifier = new Classifier(); // Classifier | 

            try {
                // Update entities and/or relationships with classifier(s).
                apiInstance.updateClassifier(accept, contentType, classifier);
            } catch (Exception e) {
                Debug.Print("Exception when calling ClassifiersApi.updateClassifier: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ClassifiersApi();
$accept = application/json; // String | 
$contentType = application/json; // String | 
$classifier = ; // Classifier | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ClassifiersApi->new();
my $accept = application/json; # String | 
my $contentType = application/json; # String | 
my $classifier = WWW::OPenAPIClient::Object::Classifier->new(); # Classifier | 

eval {
    $api_instance->updateClassifier(accept => $accept, contentType => $contentType, classifier => $classifier);
};
if ($@) {
    warn "Exception when calling ClassifiersApi->updateClassifier: $@\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.ClassifiersApi()
accept = application/json # String |  (default to application/json)
contentType = application/json # String |  (default to application/json)
classifier =  # Classifier | 

try:
    # Update entities and/or relationships with classifier(s).
    api_instance.update_classifier(accept, contentType, classifier)
except ApiException as e:
    print("Exception when calling ClassifiersApi->updateClassifier: %s\n" % e)
extern crate ClassifiersApi;

pub fn main() {
    let accept = application/json; // String
    let contentType = application/json; // String
    let classifier = ; // Classifier

    let mut context = ClassifiersApi::Context::default();
    let result = client.updateClassifier(accept, contentType, classifier, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
Accept*
String
Required
Content-Type*
String
Required
Body parameters
Name Description
classifier *

Responses


updateClassifierDeprecated

Update entities and/or relationships with classifier(s).

Update entities and/or relationships with classifier(s). The sum of the given entityIds and relationshipIds cannot exceed 100 by default.


/classifiers

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/problem+json" \
 -H "Content-Type: application/json" \
 "https://localhost/topology-inventory/v1/classifiers" \
 -d '{
  "classifiers" : [ "classifiers", "classifiers" ],
  "relationshipIds" : [ "relationshipIds", "relationshipIds" ],
  "operation" : "merge",
  "entityIds" : [ "entityIds", "entityIds" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ClassifiersApi;

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

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

        // Create an instance of the API class
        ClassifiersApi apiInstance = new ClassifiersApi();
        String accept = application/json; // String | 
        String contentType = application/json; // String | 
        Classifier classifier = ; // Classifier | 

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

final api_instance = DefaultApi();

final String accept = new String(); // String | 
final String contentType = new String(); // String | 
final Classifier classifier = new Classifier(); // Classifier | 

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

import org.openapitools.client.api.ClassifiersApi;

public class ClassifiersApiExample {
    public static void main(String[] args) {
        ClassifiersApi apiInstance = new ClassifiersApi();
        String accept = application/json; // String | 
        String contentType = application/json; // String | 
        Classifier classifier = ; // Classifier | 

        try {
            apiInstance.updateClassifierDeprecated(accept, contentType, classifier);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClassifiersApi#updateClassifierDeprecated");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ClassifiersApi *apiInstance = [[ClassifiersApi alloc] init];
String *accept = application/json; //  (default to application/json)
String *contentType = application/json; //  (default to application/json)
Classifier *classifier = ; // 

// Update entities and/or relationships with classifier(s).
[apiInstance updateClassifierDeprecatedWith:accept
    contentType:contentType
    classifier:classifier
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');

// Create an instance of the API class
var api = new TopologyExposureAndInventoryApi.ClassifiersApi()
var accept = application/json; // {String} 
var contentType = application/json; // {String} 
var classifier = ; // {Classifier} 

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

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

            // Create an instance of the API class
            var apiInstance = new ClassifiersApi();
            var accept = application/json;  // String |  (default to application/json)
            var contentType = application/json;  // String |  (default to application/json)
            var classifier = new Classifier(); // Classifier | 

            try {
                // Update entities and/or relationships with classifier(s).
                apiInstance.updateClassifierDeprecated(accept, contentType, classifier);
            } catch (Exception e) {
                Debug.Print("Exception when calling ClassifiersApi.updateClassifierDeprecated: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ClassifiersApi();
$accept = application/json; // String | 
$contentType = application/json; // String | 
$classifier = ; // Classifier | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ClassifiersApi->new();
my $accept = application/json; # String | 
my $contentType = application/json; # String | 
my $classifier = WWW::OPenAPIClient::Object::Classifier->new(); # Classifier | 

eval {
    $api_instance->updateClassifierDeprecated(accept => $accept, contentType => $contentType, classifier => $classifier);
};
if ($@) {
    warn "Exception when calling ClassifiersApi->updateClassifierDeprecated: $@\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.ClassifiersApi()
accept = application/json # String |  (default to application/json)
contentType = application/json # String |  (default to application/json)
classifier =  # Classifier | 

try:
    # Update entities and/or relationships with classifier(s).
    api_instance.update_classifier_deprecated(accept, contentType, classifier)
except ApiException as e:
    print("Exception when calling ClassifiersApi->updateClassifierDeprecated: %s\n" % e)
extern crate ClassifiersApi;

pub fn main() {
    let accept = application/json; // String
    let contentType = application/json; // String
    let classifier = ; // Classifier

    let mut context = ClassifiersApi::Context::default();
    let result = client.updateClassifierDeprecated(accept, contentType, classifier, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
Accept*
String
Required
Content-Type*
String
Required
Body parameters
Name Description
classifier *

Responses


Decorators

updateDecorator

Update entities and/or relationships with decorator(s).

Update entities and/or relationships with decorator(s).


/manage-decorators

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/problem+json" \
 -H "Content-Type: application/json" \
 "https://localhost/topology-inventory/v1/manage-decorators" \
 -d '{
  "decorators" : {
    "key" : ""
  },
  "relationshipIds" : [ "relationshipIds", "relationshipIds" ],
  "operation" : "merge",
  "entityIds" : [ "entityIds", "entityIds" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DecoratorsApi;

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

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

        // Create an instance of the API class
        DecoratorsApi apiInstance = new DecoratorsApi();
        String accept = application/json; // String | 
        String contentType = application/json; // String | 
        Decorator decorator = ; // Decorator | 

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

final api_instance = DefaultApi();

final String accept = new String(); // String | 
final String contentType = new String(); // String | 
final Decorator decorator = new Decorator(); // Decorator | 

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

import org.openapitools.client.api.DecoratorsApi;

public class DecoratorsApiExample {
    public static void main(String[] args) {
        DecoratorsApi apiInstance = new DecoratorsApi();
        String accept = application/json; // String | 
        String contentType = application/json; // String | 
        Decorator decorator = ; // Decorator | 

        try {
            apiInstance.updateDecorator(accept, contentType, decorator);
        } catch (ApiException e) {
            System.err.println("Exception when calling DecoratorsApi#updateDecorator");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DecoratorsApi *apiInstance = [[DecoratorsApi alloc] init];
String *accept = application/json; //  (default to application/json)
String *contentType = application/json; //  (default to application/json)
Decorator *decorator = ; // 

// Update entities and/or relationships with decorator(s).
[apiInstance updateDecoratorWith:accept
    contentType:contentType
    decorator:decorator
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');

// Create an instance of the API class
var api = new TopologyExposureAndInventoryApi.DecoratorsApi()
var accept = application/json; // {String} 
var contentType = application/json; // {String} 
var decorator = ; // {Decorator} 

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

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

            // Create an instance of the API class
            var apiInstance = new DecoratorsApi();
            var accept = application/json;  // String |  (default to application/json)
            var contentType = application/json;  // String |  (default to application/json)
            var decorator = new Decorator(); // Decorator | 

            try {
                // Update entities and/or relationships with decorator(s).
                apiInstance.updateDecorator(accept, contentType, decorator);
            } catch (Exception e) {
                Debug.Print("Exception when calling DecoratorsApi.updateDecorator: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DecoratorsApi();
$accept = application/json; // String | 
$contentType = application/json; // String | 
$decorator = ; // Decorator | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DecoratorsApi->new();
my $accept = application/json; # String | 
my $contentType = application/json; # String | 
my $decorator = WWW::OPenAPIClient::Object::Decorator->new(); # Decorator | 

eval {
    $api_instance->updateDecorator(accept => $accept, contentType => $contentType, decorator => $decorator);
};
if ($@) {
    warn "Exception when calling DecoratorsApi->updateDecorator: $@\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.DecoratorsApi()
accept = application/json # String |  (default to application/json)
contentType = application/json # String |  (default to application/json)
decorator =  # Decorator | 

try:
    # Update entities and/or relationships with decorator(s).
    api_instance.update_decorator(accept, contentType, decorator)
except ApiException as e:
    print("Exception when calling DecoratorsApi->updateDecorator: %s\n" % e)
extern crate DecoratorsApi;

pub fn main() {
    let accept = application/json; // String
    let contentType = application/json; // String
    let decorator = ; // Decorator

    let mut context = DecoratorsApi::Context::default();
    let result = client.updateDecorator(accept, contentType, decorator, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
Accept*
String
Required
Content-Type*
String
Required
Body parameters
Name Description
decorator *

Responses


updateDecoratorDeprecated

Update entities and/or relationships with decorator(s).

Update entities and/or relationships with decorator(s). The sum of the given entityIds and relationshipIds cannot exceed 100 by default.


/decorators

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/problem+json" \
 -H "Content-Type: application/json" \
 "https://localhost/topology-inventory/v1/decorators" \
 -d '{
  "decorators" : {
    "key" : ""
  },
  "relationshipIds" : [ "relationshipIds", "relationshipIds" ],
  "operation" : "merge",
  "entityIds" : [ "entityIds", "entityIds" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DecoratorsApi;

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

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

        // Create an instance of the API class
        DecoratorsApi apiInstance = new DecoratorsApi();
        String accept = application/json; // String | 
        String contentType = application/json; // String | 
        Decorator decorator = ; // Decorator | 

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

final api_instance = DefaultApi();

final String accept = new String(); // String | 
final String contentType = new String(); // String | 
final Decorator decorator = new Decorator(); // Decorator | 

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

import org.openapitools.client.api.DecoratorsApi;

public class DecoratorsApiExample {
    public static void main(String[] args) {
        DecoratorsApi apiInstance = new DecoratorsApi();
        String accept = application/json; // String | 
        String contentType = application/json; // String | 
        Decorator decorator = ; // Decorator | 

        try {
            apiInstance.updateDecoratorDeprecated(accept, contentType, decorator);
        } catch (ApiException e) {
            System.err.println("Exception when calling DecoratorsApi#updateDecoratorDeprecated");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DecoratorsApi *apiInstance = [[DecoratorsApi alloc] init];
String *accept = application/json; //  (default to application/json)
String *contentType = application/json; //  (default to application/json)
Decorator *decorator = ; // 

// Update entities and/or relationships with decorator(s).
[apiInstance updateDecoratorDeprecatedWith:accept
    contentType:contentType
    decorator:decorator
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');

// Create an instance of the API class
var api = new TopologyExposureAndInventoryApi.DecoratorsApi()
var accept = application/json; // {String} 
var contentType = application/json; // {String} 
var decorator = ; // {Decorator} 

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

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

            // Create an instance of the API class
            var apiInstance = new DecoratorsApi();
            var accept = application/json;  // String |  (default to application/json)
            var contentType = application/json;  // String |  (default to application/json)
            var decorator = new Decorator(); // Decorator | 

            try {
                // Update entities and/or relationships with decorator(s).
                apiInstance.updateDecoratorDeprecated(accept, contentType, decorator);
            } catch (Exception e) {
                Debug.Print("Exception when calling DecoratorsApi.updateDecoratorDeprecated: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DecoratorsApi();
$accept = application/json; // String | 
$contentType = application/json; // String | 
$decorator = ; // Decorator | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DecoratorsApi->new();
my $accept = application/json; # String | 
my $contentType = application/json; # String | 
my $decorator = WWW::OPenAPIClient::Object::Decorator->new(); # Decorator | 

eval {
    $api_instance->updateDecoratorDeprecated(accept => $accept, contentType => $contentType, decorator => $decorator);
};
if ($@) {
    warn "Exception when calling DecoratorsApi->updateDecoratorDeprecated: $@\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.DecoratorsApi()
accept = application/json # String |  (default to application/json)
contentType = application/json # String |  (default to application/json)
decorator =  # Decorator | 

try:
    # Update entities and/or relationships with decorator(s).
    api_instance.update_decorator_deprecated(accept, contentType, decorator)
except ApiException as e:
    print("Exception when calling DecoratorsApi->updateDecoratorDeprecated: %s\n" % e)
extern crate DecoratorsApi;

pub fn main() {
    let accept = application/json; // String
    let contentType = application/json; // String
    let decorator = ; // Decorator

    let mut context = DecoratorsApi::Context::default();
    let result = client.updateDecoratorDeprecated(accept, contentType, decorator, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
Accept*
String
Required
Content-Type*
String
Required
Body parameters
Name Description
decorator *

Responses


EntitiesAndRelationships

getAllDomains

Get all the available topology domains.

Get all the available topology domains.


/domains

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://localhost/topology-inventory/v1/domains?offset=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntitiesAndRelationshipsApi;

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

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

        // Create an instance of the API class
        EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
        String accept = application/json; // String | 
        Integer offset = 56; // Integer | Pagination offset.
        Integer limit = 56; // Integer | Result limiter.

        try {
            Domains result = apiInstance.getAllDomains(accept, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntitiesAndRelationshipsApi#getAllDomains");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String accept = new String(); // String | 
final Integer offset = new Integer(); // Integer | Pagination offset.
final Integer limit = new Integer(); // Integer | Result limiter.

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

import org.openapitools.client.api.EntitiesAndRelationshipsApi;

public class EntitiesAndRelationshipsApiExample {
    public static void main(String[] args) {
        EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
        String accept = application/json; // String | 
        Integer offset = 56; // Integer | Pagination offset.
        Integer limit = 56; // Integer | Result limiter.

        try {
            Domains result = apiInstance.getAllDomains(accept, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntitiesAndRelationshipsApi#getAllDomains");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntitiesAndRelationshipsApi *apiInstance = [[EntitiesAndRelationshipsApi alloc] init];
String *accept = application/json; //  (default to application/json)
Integer *offset = 56; // Pagination offset. (optional) (default to 0)
Integer *limit = 56; // Result limiter. (optional) (default to 500)

// Get all the available topology domains.
[apiInstance getAllDomainsWith:accept
    offset:offset
    limit:limit
              completionHandler: ^(Domains output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');

// Create an instance of the API class
var api = new TopologyExposureAndInventoryApi.EntitiesAndRelationshipsApi()
var accept = application/json; // {String} 
var opts = {
  'offset': 56, // {Integer} Pagination offset.
  'limit': 56 // {Integer} Result limiter.
};

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

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

            // Create an instance of the API class
            var apiInstance = new EntitiesAndRelationshipsApi();
            var accept = application/json;  // String |  (default to application/json)
            var offset = 56;  // Integer | Pagination offset. (optional)  (default to 0)
            var limit = 56;  // Integer | Result limiter. (optional)  (default to 500)

            try {
                // Get all the available topology domains.
                Domains result = apiInstance.getAllDomains(accept, offset, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getAllDomains: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntitiesAndRelationshipsApi();
$accept = application/json; // String | 
$offset = 56; // Integer | Pagination offset.
$limit = 56; // Integer | Result limiter.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntitiesAndRelationshipsApi->new();
my $accept = application/json; # String | 
my $offset = 56; # Integer | Pagination offset.
my $limit = 56; # Integer | Result limiter.

eval {
    my $result = $api_instance->getAllDomains(accept => $accept, offset => $offset, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntitiesAndRelationshipsApi->getAllDomains: $@\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.EntitiesAndRelationshipsApi()
accept = application/json # String |  (default to application/json)
offset = 56 # Integer | Pagination offset. (optional) (default to 0)
limit = 56 # Integer | Result limiter. (optional) (default to 500)

try:
    # Get all the available topology domains.
    api_response = api_instance.get_all_domains(accept, offset=offset, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntitiesAndRelationshipsApi->getAllDomains: %s\n" % e)
extern crate EntitiesAndRelationshipsApi;

pub fn main() {
    let accept = application/json; // String
    let offset = 56; // Integer
    let limit = 56; // Integer

    let mut context = EntitiesAndRelationshipsApi::Context::default();
    let result = client.getAllDomains(accept, offset, limit, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
Accept*
String
Required
Query parameters
Name Description
offset
Integer
Pagination offset.
limit
Integer
Result limiter.

Responses


getAllRelationshipsForEntityId

Get all relationships for a specific Topology Entity instance of a Topology Entity type

Get all relationships for a specific Topology Entity instance of a Topology Entity type


/domains/{domainName}/entity-types/{entityTypeName}/entities/{entityId}/relationships

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://localhost/topology-inventory/v1/domains/{domainName}/entity-types/{entityTypeName}/entities/{entityId}/relationships?targetFilter=/sourceIds;/classifiers&scopeFilter=/sourceIds[contains(@item,'ManagedElement=1')]&offset=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntitiesAndRelationshipsApi;

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

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

        // Create an instance of the API class
        EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
        String accept = application/json; // String | 
        String domainName = RAN; // String | domain name
        String entityTypeName = entityTypeName_example; // String | 
        String entityId = entityId_example; // String | 
        String targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
        String scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
        Integer offset = 56; // Integer | Pagination offset.
        Integer limit = 56; // Integer | Result limiter.

        try {
            Relationships result = apiInstance.getAllRelationshipsForEntityId(accept, domainName, entityTypeName, entityId, targetFilter, scopeFilter, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntitiesAndRelationshipsApi#getAllRelationshipsForEntityId");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String accept = new String(); // String | 
final String domainName = new String(); // String | domain name
final String entityTypeName = new String(); // String | 
final String entityId = new String(); // String | 
final String targetFilter = new String(); // String | Use *targetFilter* to specify what needs to be returned in the REST response.
final String scopeFilter = new String(); // String | ScopeFilter is used to specify the conditions to be applied.
final Integer offset = new Integer(); // Integer | Pagination offset.
final Integer limit = new Integer(); // Integer | Result limiter.

try {
    final result = await api_instance.getAllRelationshipsForEntityId(accept, domainName, entityTypeName, entityId, targetFilter, scopeFilter, offset, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getAllRelationshipsForEntityId: $e\n');
}

import org.openapitools.client.api.EntitiesAndRelationshipsApi;

public class EntitiesAndRelationshipsApiExample {
    public static void main(String[] args) {
        EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
        String accept = application/json; // String | 
        String domainName = RAN; // String | domain name
        String entityTypeName = entityTypeName_example; // String | 
        String entityId = entityId_example; // String | 
        String targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
        String scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
        Integer offset = 56; // Integer | Pagination offset.
        Integer limit = 56; // Integer | Result limiter.

        try {
            Relationships result = apiInstance.getAllRelationshipsForEntityId(accept, domainName, entityTypeName, entityId, targetFilter, scopeFilter, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntitiesAndRelationshipsApi#getAllRelationshipsForEntityId");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntitiesAndRelationshipsApi *apiInstance = [[EntitiesAndRelationshipsApi alloc] init];
String *accept = application/json; //  (default to application/json)
String *domainName = RAN; // domain name (default to null)
String *entityTypeName = entityTypeName_example; //  (default to null)
String *entityId = entityId_example; //  (default to null)
String *targetFilter = /sourceIds;/classifiers; // Use *targetFilter* to specify what needs to be returned in the REST response. (optional) (default to null)
String *scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // ScopeFilter is used to specify the conditions to be applied. (optional) (default to null)
Integer *offset = 56; // Pagination offset. (optional) (default to 0)
Integer *limit = 56; // Result limiter. (optional) (default to 500)

// Get all relationships for a specific Topology Entity instance of a Topology Entity type
[apiInstance getAllRelationshipsForEntityIdWith:accept
    domainName:domainName
    entityTypeName:entityTypeName
    entityId:entityId
    targetFilter:targetFilter
    scopeFilter:scopeFilter
    offset:offset
    limit:limit
              completionHandler: ^(Relationships output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');

// Create an instance of the API class
var api = new TopologyExposureAndInventoryApi.EntitiesAndRelationshipsApi()
var accept = application/json; // {String} 
var domainName = RAN; // {String} domain name
var entityTypeName = entityTypeName_example; // {String} 
var entityId = entityId_example; // {String} 
var opts = {
  'targetFilter': /sourceIds;/classifiers, // {String} Use *targetFilter* to specify what needs to be returned in the REST response.
  'scopeFilter': /sourceIds[contains(@item,'ManagedElement=1')], // {String} ScopeFilter is used to specify the conditions to be applied.
  'offset': 56, // {Integer} Pagination offset.
  'limit': 56 // {Integer} Result limiter.
};

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

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

            // Create an instance of the API class
            var apiInstance = new EntitiesAndRelationshipsApi();
            var accept = application/json;  // String |  (default to application/json)
            var domainName = RAN;  // String | domain name (default to null)
            var entityTypeName = entityTypeName_example;  // String |  (default to null)
            var entityId = entityId_example;  // String |  (default to null)
            var targetFilter = /sourceIds;/classifiers;  // String | Use *targetFilter* to specify what needs to be returned in the REST response. (optional)  (default to null)
            var scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')];  // String | ScopeFilter is used to specify the conditions to be applied. (optional)  (default to null)
            var offset = 56;  // Integer | Pagination offset. (optional)  (default to 0)
            var limit = 56;  // Integer | Result limiter. (optional)  (default to 500)

            try {
                // Get all relationships for a specific Topology Entity instance of a Topology Entity type
                Relationships result = apiInstance.getAllRelationshipsForEntityId(accept, domainName, entityTypeName, entityId, targetFilter, scopeFilter, offset, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getAllRelationshipsForEntityId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntitiesAndRelationshipsApi();
$accept = application/json; // String | 
$domainName = RAN; // String | domain name
$entityTypeName = entityTypeName_example; // String | 
$entityId = entityId_example; // String | 
$targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
$scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
$offset = 56; // Integer | Pagination offset.
$limit = 56; // Integer | Result limiter.

try {
    $result = $api_instance->getAllRelationshipsForEntityId($accept, $domainName, $entityTypeName, $entityId, $targetFilter, $scopeFilter, $offset, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntitiesAndRelationshipsApi->getAllRelationshipsForEntityId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntitiesAndRelationshipsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntitiesAndRelationshipsApi->new();
my $accept = application/json; # String | 
my $domainName = RAN; # String | domain name
my $entityTypeName = entityTypeName_example; # String | 
my $entityId = entityId_example; # String | 
my $targetFilter = /sourceIds;/classifiers; # String | Use *targetFilter* to specify what needs to be returned in the REST response.
my $scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; # String | ScopeFilter is used to specify the conditions to be applied.
my $offset = 56; # Integer | Pagination offset.
my $limit = 56; # Integer | Result limiter.

eval {
    my $result = $api_instance->getAllRelationshipsForEntityId(accept => $accept, domainName => $domainName, entityTypeName => $entityTypeName, entityId => $entityId, targetFilter => $targetFilter, scopeFilter => $scopeFilter, offset => $offset, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntitiesAndRelationshipsApi->getAllRelationshipsForEntityId: $@\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.EntitiesAndRelationshipsApi()
accept = application/json # String |  (default to application/json)
domainName = RAN # String | domain name (default to null)
entityTypeName = entityTypeName_example # String |  (default to null)
entityId = entityId_example # String |  (default to null)
targetFilter = /sourceIds;/classifiers # String | Use *targetFilter* to specify what needs to be returned in the REST response. (optional) (default to null)
scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')] # String | ScopeFilter is used to specify the conditions to be applied. (optional) (default to null)
offset = 56 # Integer | Pagination offset. (optional) (default to 0)
limit = 56 # Integer | Result limiter. (optional) (default to 500)

try:
    # Get all relationships for a specific Topology Entity instance of a Topology Entity type
    api_response = api_instance.get_all_relationships_for_entity_id(accept, domainName, entityTypeName, entityId, targetFilter=targetFilter, scopeFilter=scopeFilter, offset=offset, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntitiesAndRelationshipsApi->getAllRelationshipsForEntityId: %s\n" % e)
extern crate EntitiesAndRelationshipsApi;

pub fn main() {
    let accept = application/json; // String
    let domainName = RAN; // String
    let entityTypeName = entityTypeName_example; // String
    let entityId = entityId_example; // String
    let targetFilter = /sourceIds;/classifiers; // String
    let scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String
    let offset = 56; // Integer
    let limit = 56; // Integer

    let mut context = EntitiesAndRelationshipsApi::Context::default();
    let result = client.getAllRelationshipsForEntityId(accept, domainName, entityTypeName, entityId, targetFilter, scopeFilter, offset, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
domainName*
String
domain name
Required
entityTypeName*
String
Required
entityId*
String
Required
Header parameters
Name Description
Accept*
String
Required
Query parameters
Name Description
targetFilter
String
Use *targetFilter* to specify what needs to be returned in the REST response.
scopeFilter
String
ScopeFilter is used to specify the conditions to be applied.
offset
Integer
Pagination offset.
limit
Integer
Result limiter.

Responses


getEntitiesByDomain

Get entities by domain

Get topology entities by domain, using a specified *targetFilter* as a query parameter.


/domains/{domainName}/entities

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://localhost/topology-inventory/v1/domains/{domainName}/entities?targetFilter=/sourceIds;/classifiers&scopeFilter=/sourceIds[contains(@item,'ManagedElement=1')]&offset=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntitiesAndRelationshipsApi;

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

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

        // Create an instance of the API class
        EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
        String accept = application/json; // String | 
        String domainName = RAN; // String | domain name
        String targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
        String scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
        Integer offset = 56; // Integer | Pagination offset.
        Integer limit = 56; // Integer | Result limiter.

        try {
            Entities result = apiInstance.getEntitiesByDomain(accept, domainName, targetFilter, scopeFilter, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntitiesAndRelationshipsApi#getEntitiesByDomain");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String accept = new String(); // String | 
final String domainName = new String(); // String | domain name
final String targetFilter = new String(); // String | Use *targetFilter* to specify what needs to be returned in the REST response.
final String scopeFilter = new String(); // String | ScopeFilter is used to specify the conditions to be applied.
final Integer offset = new Integer(); // Integer | Pagination offset.
final Integer limit = new Integer(); // Integer | Result limiter.

try {
    final result = await api_instance.getEntitiesByDomain(accept, domainName, targetFilter, scopeFilter, offset, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getEntitiesByDomain: $e\n');
}

import org.openapitools.client.api.EntitiesAndRelationshipsApi;

public class EntitiesAndRelationshipsApiExample {
    public static void main(String[] args) {
        EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
        String accept = application/json; // String | 
        String domainName = RAN; // String | domain name
        String targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
        String scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
        Integer offset = 56; // Integer | Pagination offset.
        Integer limit = 56; // Integer | Result limiter.

        try {
            Entities result = apiInstance.getEntitiesByDomain(accept, domainName, targetFilter, scopeFilter, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntitiesAndRelationshipsApi#getEntitiesByDomain");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntitiesAndRelationshipsApi *apiInstance = [[EntitiesAndRelationshipsApi alloc] init];
String *accept = application/json; //  (default to application/json)
String *domainName = RAN; // domain name (default to null)
String *targetFilter = /sourceIds;/classifiers; // Use *targetFilter* to specify what needs to be returned in the REST response. (optional) (default to null)
String *scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // ScopeFilter is used to specify the conditions to be applied. (optional) (default to null)
Integer *offset = 56; // Pagination offset. (optional) (default to 0)
Integer *limit = 56; // Result limiter. (optional) (default to 500)

// Get entities by domain
[apiInstance getEntitiesByDomainWith:accept
    domainName:domainName
    targetFilter:targetFilter
    scopeFilter:scopeFilter
    offset:offset
    limit:limit
              completionHandler: ^(Entities output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');

// Create an instance of the API class
var api = new TopologyExposureAndInventoryApi.EntitiesAndRelationshipsApi()
var accept = application/json; // {String} 
var domainName = RAN; // {String} domain name
var opts = {
  'targetFilter': /sourceIds;/classifiers, // {String} Use *targetFilter* to specify what needs to be returned in the REST response.
  'scopeFilter': /sourceIds[contains(@item,'ManagedElement=1')], // {String} ScopeFilter is used to specify the conditions to be applied.
  'offset': 56, // {Integer} Pagination offset.
  'limit': 56 // {Integer} Result limiter.
};

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

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

            // Create an instance of the API class
            var apiInstance = new EntitiesAndRelationshipsApi();
            var accept = application/json;  // String |  (default to application/json)
            var domainName = RAN;  // String | domain name (default to null)
            var targetFilter = /sourceIds;/classifiers;  // String | Use *targetFilter* to specify what needs to be returned in the REST response. (optional)  (default to null)
            var scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')];  // String | ScopeFilter is used to specify the conditions to be applied. (optional)  (default to null)
            var offset = 56;  // Integer | Pagination offset. (optional)  (default to 0)
            var limit = 56;  // Integer | Result limiter. (optional)  (default to 500)

            try {
                // Get entities by domain
                Entities result = apiInstance.getEntitiesByDomain(accept, domainName, targetFilter, scopeFilter, offset, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getEntitiesByDomain: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntitiesAndRelationshipsApi();
$accept = application/json; // String | 
$domainName = RAN; // String | domain name
$targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
$scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
$offset = 56; // Integer | Pagination offset.
$limit = 56; // Integer | Result limiter.

try {
    $result = $api_instance->getEntitiesByDomain($accept, $domainName, $targetFilter, $scopeFilter, $offset, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntitiesAndRelationshipsApi->getEntitiesByDomain: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntitiesAndRelationshipsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntitiesAndRelationshipsApi->new();
my $accept = application/json; # String | 
my $domainName = RAN; # String | domain name
my $targetFilter = /sourceIds;/classifiers; # String | Use *targetFilter* to specify what needs to be returned in the REST response.
my $scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; # String | ScopeFilter is used to specify the conditions to be applied.
my $offset = 56; # Integer | Pagination offset.
my $limit = 56; # Integer | Result limiter.

eval {
    my $result = $api_instance->getEntitiesByDomain(accept => $accept, domainName => $domainName, targetFilter => $targetFilter, scopeFilter => $scopeFilter, offset => $offset, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntitiesAndRelationshipsApi->getEntitiesByDomain: $@\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.EntitiesAndRelationshipsApi()
accept = application/json # String |  (default to application/json)
domainName = RAN # String | domain name (default to null)
targetFilter = /sourceIds;/classifiers # String | Use *targetFilter* to specify what needs to be returned in the REST response. (optional) (default to null)
scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')] # String | ScopeFilter is used to specify the conditions to be applied. (optional) (default to null)
offset = 56 # Integer | Pagination offset. (optional) (default to 0)
limit = 56 # Integer | Result limiter. (optional) (default to 500)

try:
    # Get entities by domain
    api_response = api_instance.get_entities_by_domain(accept, domainName, targetFilter=targetFilter, scopeFilter=scopeFilter, offset=offset, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntitiesAndRelationshipsApi->getEntitiesByDomain: %s\n" % e)
extern crate EntitiesAndRelationshipsApi;

pub fn main() {
    let accept = application/json; // String
    let domainName = RAN; // String
    let targetFilter = /sourceIds;/classifiers; // String
    let scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String
    let offset = 56; // Integer
    let limit = 56; // Integer

    let mut context = EntitiesAndRelationshipsApi::Context::default();
    let result = client.getEntitiesByDomain(accept, domainName, targetFilter, scopeFilter, offset, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
domainName*
String
domain name
Required
Header parameters
Name Description
Accept*
String
Required
Query parameters
Name Description
targetFilter
String
Use *targetFilter* to specify what needs to be returned in the REST response.
scopeFilter
String
ScopeFilter is used to specify the conditions to be applied.
offset
Integer
Pagination offset.
limit
Integer
Result limiter.

Responses


getRelationshipById

Get a specific Topology Relationship instance of a Topology Relationship type.

Get a specific Topology Relationship instance of a Topology Relationship type.


/domains/{domainName}/relationship-types/{relationshipTypeName}/relationships/{relationshipId}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/yang.data+json,application/problem+json" \
 "https://localhost/topology-inventory/v1/domains/{domainName}/relationship-types/{relationshipTypeName}/relationships/{relationshipId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntitiesAndRelationshipsApi;

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

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

        // Create an instance of the API class
        EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
        String accept = application/yang.data+json; // String | 
        String domainName = RAN; // String | domain name
        String relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String | 
        String relationshipId = relationshipId_example; // String | 

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

final api_instance = DefaultApi();

final String accept = new String(); // String | 
final String domainName = new String(); // String | domain name
final String relationshipTypeName = new String(); // String | 
final String relationshipId = new String(); // String | 

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

import org.openapitools.client.api.EntitiesAndRelationshipsApi;

public class EntitiesAndRelationshipsApiExample {
    public static void main(String[] args) {
        EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
        String accept = application/yang.data+json; // String | 
        String domainName = RAN; // String | domain name
        String relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String | 
        String relationshipId = relationshipId_example; // String | 

        try {
            Object result = apiInstance.getRelationshipById(accept, domainName, relationshipTypeName, relationshipId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntitiesAndRelationshipsApi#getRelationshipById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntitiesAndRelationshipsApi *apiInstance = [[EntitiesAndRelationshipsApi alloc] init];
String *accept = application/yang.data+json; //  (default to application/yang.data+json)
String *domainName = RAN; // domain name (default to null)
String *relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; //  (default to null)
String *relationshipId = relationshipId_example; //  (default to null)

// Get a specific Topology Relationship instance of a Topology Relationship type.
[apiInstance getRelationshipByIdWith:accept
    domainName:domainName
    relationshipTypeName:relationshipTypeName
    relationshipId:relationshipId
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');

// Create an instance of the API class
var api = new TopologyExposureAndInventoryApi.EntitiesAndRelationshipsApi()
var accept = application/yang.data+json; // {String} 
var domainName = RAN; // {String} domain name
var relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // {String} 
var relationshipId = relationshipId_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new EntitiesAndRelationshipsApi();
            var accept = application/yang.data+json;  // String |  (default to application/yang.data+json)
            var domainName = RAN;  // String | domain name (default to null)
            var relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER;  // String |  (default to null)
            var relationshipId = relationshipId_example;  // String |  (default to null)

            try {
                // Get a specific Topology Relationship instance of a Topology Relationship type.
                Object result = apiInstance.getRelationshipById(accept, domainName, relationshipTypeName, relationshipId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getRelationshipById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntitiesAndRelationshipsApi();
$accept = application/yang.data+json; // String | 
$domainName = RAN; // String | domain name
$relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String | 
$relationshipId = relationshipId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntitiesAndRelationshipsApi->new();
my $accept = application/yang.data+json; # String | 
my $domainName = RAN; # String | domain name
my $relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; # String | 
my $relationshipId = relationshipId_example; # String | 

eval {
    my $result = $api_instance->getRelationshipById(accept => $accept, domainName => $domainName, relationshipTypeName => $relationshipTypeName, relationshipId => $relationshipId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntitiesAndRelationshipsApi->getRelationshipById: $@\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.EntitiesAndRelationshipsApi()
accept = application/yang.data+json # String |  (default to application/yang.data+json)
domainName = RAN # String | domain name (default to null)
relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER # String |  (default to null)
relationshipId = relationshipId_example # String |  (default to null)

try:
    # Get a specific Topology Relationship instance of a Topology Relationship type.
    api_response = api_instance.get_relationship_by_id(accept, domainName, relationshipTypeName, relationshipId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntitiesAndRelationshipsApi->getRelationshipById: %s\n" % e)
extern crate EntitiesAndRelationshipsApi;

pub fn main() {
    let accept = application/yang.data+json; // String
    let domainName = RAN; // String
    let relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String
    let relationshipId = relationshipId_example; // String

    let mut context = EntitiesAndRelationshipsApi::Context::default();
    let result = client.getRelationshipById(accept, domainName, relationshipTypeName, relationshipId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
domainName*
String
domain name
Required
relationshipTypeName*
String
Required
relationshipId*
String
Required
Header parameters
Name Description
Accept*
String
Required

Responses


getRelationshipsByType

Get all the available Topology Relationships of a specific relationship type name.

Get all the available Topology Relationships of a specific relationship type name name.


/domains/{domainName}/relationship-types/{relationshipTypeName}/relationships

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://localhost/topology-inventory/v1/domains/{domainName}/relationship-types/{relationshipTypeName}/relationships?targetFilter=/sourceIds;/classifiers&scopeFilter=/sourceIds[contains(@item,'ManagedElement=1')]&offset=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntitiesAndRelationshipsApi;

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

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

        // Create an instance of the API class
        EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
        String accept = application/json; // String | 
        String domainName = RAN; // String | domain name
        String relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String | 
        String targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
        String scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
        Integer offset = 56; // Integer | Pagination offset.
        Integer limit = 56; // Integer | Result limiter.

        try {
            Relationships result = apiInstance.getRelationshipsByType(accept, domainName, relationshipTypeName, targetFilter, scopeFilter, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntitiesAndRelationshipsApi#getRelationshipsByType");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String accept = new String(); // String | 
final String domainName = new String(); // String | domain name
final String relationshipTypeName = new String(); // String | 
final String targetFilter = new String(); // String | Use *targetFilter* to specify what needs to be returned in the REST response.
final String scopeFilter = new String(); // String | ScopeFilter is used to specify the conditions to be applied.
final Integer offset = new Integer(); // Integer | Pagination offset.
final Integer limit = new Integer(); // Integer | Result limiter.

try {
    final result = await api_instance.getRelationshipsByType(accept, domainName, relationshipTypeName, targetFilter, scopeFilter, offset, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getRelationshipsByType: $e\n');
}

import org.openapitools.client.api.EntitiesAndRelationshipsApi;

public class EntitiesAndRelationshipsApiExample {
    public static void main(String[] args) {
        EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
        String accept = application/json; // String | 
        String domainName = RAN; // String | domain name
        String relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String | 
        String targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
        String scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
        Integer offset = 56; // Integer | Pagination offset.
        Integer limit = 56; // Integer | Result limiter.

        try {
            Relationships result = apiInstance.getRelationshipsByType(accept, domainName, relationshipTypeName, targetFilter, scopeFilter, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntitiesAndRelationshipsApi#getRelationshipsByType");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntitiesAndRelationshipsApi *apiInstance = [[EntitiesAndRelationshipsApi alloc] init];
String *accept = application/json; //  (default to application/json)
String *domainName = RAN; // domain name (default to null)
String *relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; //  (default to null)
String *targetFilter = /sourceIds;/classifiers; // Use *targetFilter* to specify what needs to be returned in the REST response. (optional) (default to null)
String *scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // ScopeFilter is used to specify the conditions to be applied. (optional) (default to null)
Integer *offset = 56; // Pagination offset. (optional) (default to 0)
Integer *limit = 56; // Result limiter. (optional) (default to 500)

// Get all the available Topology Relationships of a specific relationship type name.
[apiInstance getRelationshipsByTypeWith:accept
    domainName:domainName
    relationshipTypeName:relationshipTypeName
    targetFilter:targetFilter
    scopeFilter:scopeFilter
    offset:offset
    limit:limit
              completionHandler: ^(Relationships output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');

// Create an instance of the API class
var api = new TopologyExposureAndInventoryApi.EntitiesAndRelationshipsApi()
var accept = application/json; // {String} 
var domainName = RAN; // {String} domain name
var relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // {String} 
var opts = {
  'targetFilter': /sourceIds;/classifiers, // {String} Use *targetFilter* to specify what needs to be returned in the REST response.
  'scopeFilter': /sourceIds[contains(@item,'ManagedElement=1')], // {String} ScopeFilter is used to specify the conditions to be applied.
  'offset': 56, // {Integer} Pagination offset.
  'limit': 56 // {Integer} Result limiter.
};

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

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

            // Create an instance of the API class
            var apiInstance = new EntitiesAndRelationshipsApi();
            var accept = application/json;  // String |  (default to application/json)
            var domainName = RAN;  // String | domain name (default to null)
            var relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER;  // String |  (default to null)
            var targetFilter = /sourceIds;/classifiers;  // String | Use *targetFilter* to specify what needs to be returned in the REST response. (optional)  (default to null)
            var scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')];  // String | ScopeFilter is used to specify the conditions to be applied. (optional)  (default to null)
            var offset = 56;  // Integer | Pagination offset. (optional)  (default to 0)
            var limit = 56;  // Integer | Result limiter. (optional)  (default to 500)

            try {
                // Get all the available Topology Relationships of a specific relationship type name.
                Relationships result = apiInstance.getRelationshipsByType(accept, domainName, relationshipTypeName, targetFilter, scopeFilter, offset, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getRelationshipsByType: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntitiesAndRelationshipsApi();
$accept = application/json; // String | 
$domainName = RAN; // String | domain name
$relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String | 
$targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
$scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
$offset = 56; // Integer | Pagination offset.
$limit = 56; // Integer | Result limiter.

try {
    $result = $api_instance->getRelationshipsByType($accept, $domainName, $relationshipTypeName, $targetFilter, $scopeFilter, $offset, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntitiesAndRelationshipsApi->getRelationshipsByType: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntitiesAndRelationshipsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntitiesAndRelationshipsApi->new();
my $accept = application/json; # String | 
my $domainName = RAN; # String | domain name
my $relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; # String | 
my $targetFilter = /sourceIds;/classifiers; # String | Use *targetFilter* to specify what needs to be returned in the REST response.
my $scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; # String | ScopeFilter is used to specify the conditions to be applied.
my $offset = 56; # Integer | Pagination offset.
my $limit = 56; # Integer | Result limiter.

eval {
    my $result = $api_instance->getRelationshipsByType(accept => $accept, domainName => $domainName, relationshipTypeName => $relationshipTypeName, targetFilter => $targetFilter, scopeFilter => $scopeFilter, offset => $offset, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntitiesAndRelationshipsApi->getRelationshipsByType: $@\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.EntitiesAndRelationshipsApi()
accept = application/json # String |  (default to application/json)
domainName = RAN # String | domain name (default to null)
relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER # String |  (default to null)
targetFilter = /sourceIds;/classifiers # String | Use *targetFilter* to specify what needs to be returned in the REST response. (optional) (default to null)
scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')] # String | ScopeFilter is used to specify the conditions to be applied. (optional) (default to null)
offset = 56 # Integer | Pagination offset. (optional) (default to 0)
limit = 56 # Integer | Result limiter. (optional) (default to 500)

try:
    # Get all the available Topology Relationships of a specific relationship type name.
    api_response = api_instance.get_relationships_by_type(accept, domainName, relationshipTypeName, targetFilter=targetFilter, scopeFilter=scopeFilter, offset=offset, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntitiesAndRelationshipsApi->getRelationshipsByType: %s\n" % e)
extern crate EntitiesAndRelationshipsApi;

pub fn main() {
    let accept = application/json; // String
    let domainName = RAN; // String
    let relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String
    let targetFilter = /sourceIds;/classifiers; // String
    let scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String
    let offset = 56; // Integer
    let limit = 56; // Integer

    let mut context = EntitiesAndRelationshipsApi::Context::default();
    let result = client.getRelationshipsByType(accept, domainName, relationshipTypeName, targetFilter, scopeFilter, offset, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
domainName*
String
domain name
Required
relationshipTypeName*
String
Required
Header parameters
Name Description
Accept*
String
Required
Query parameters
Name Description
targetFilter
String
Use *targetFilter* to specify what needs to be returned in the REST response.
scopeFilter
String
ScopeFilter is used to specify the conditions to be applied.
offset
Integer
Pagination offset.
limit
Integer
Result limiter.

Responses


getTopologyByEntityTypeName

Get all topology entities of a specific entity type.

Get all topology entities of a specific entity type.


/domains/{domainName}/entity-types/{entityTypeName}/entities

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://localhost/topology-inventory/v1/domains/{domainName}/entity-types/{entityTypeName}/entities?targetFilter=/sourceIds;/classifiers&scopeFilter=/sourceIds[contains(@item,'ManagedElement=1')]&offset=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntitiesAndRelationshipsApi;

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

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

        // Create an instance of the API class
        EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
        String accept = application/json; // String | 
        String domainName = RAN; // String | domain name
        String entityTypeName = entityTypeName_example; // String | 
        String targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
        String scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
        Integer offset = 56; // Integer | Pagination offset.
        Integer limit = 56; // Integer | Result limiter.

        try {
            Entities result = apiInstance.getTopologyByEntityTypeName(accept, domainName, entityTypeName, targetFilter, scopeFilter, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyByEntityTypeName");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String accept = new String(); // String | 
final String domainName = new String(); // String | domain name
final String entityTypeName = new String(); // String | 
final String targetFilter = new String(); // String | Use *targetFilter* to specify what needs to be returned in the REST response.
final String scopeFilter = new String(); // String | ScopeFilter is used to specify the conditions to be applied.
final Integer offset = new Integer(); // Integer | Pagination offset.
final Integer limit = new Integer(); // Integer | Result limiter.

try {
    final result = await api_instance.getTopologyByEntityTypeName(accept, domainName, entityTypeName, targetFilter, scopeFilter, offset, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getTopologyByEntityTypeName: $e\n');
}

import org.openapitools.client.api.EntitiesAndRelationshipsApi;

public class EntitiesAndRelationshipsApiExample {
    public static void main(String[] args) {
        EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
        String accept = application/json; // String | 
        String domainName = RAN; // String | domain name
        String entityTypeName = entityTypeName_example; // String | 
        String targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
        String scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
        Integer offset = 56; // Integer | Pagination offset.
        Integer limit = 56; // Integer | Result limiter.

        try {
            Entities result = apiInstance.getTopologyByEntityTypeName(accept, domainName, entityTypeName, targetFilter, scopeFilter, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyByEntityTypeName");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntitiesAndRelationshipsApi *apiInstance = [[EntitiesAndRelationshipsApi alloc] init];
String *accept = application/json; //  (default to application/json)
String *domainName = RAN; // domain name (default to null)
String *entityTypeName = entityTypeName_example; //  (default to null)
String *targetFilter = /sourceIds;/classifiers; // Use *targetFilter* to specify what needs to be returned in the REST response. (optional) (default to null)
String *scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // ScopeFilter is used to specify the conditions to be applied. (optional) (default to null)
Integer *offset = 56; // Pagination offset. (optional) (default to 0)
Integer *limit = 56; // Result limiter. (optional) (default to 500)

// Get all topology entities of a specific entity type.
[apiInstance getTopologyByEntityTypeNameWith:accept
    domainName:domainName
    entityTypeName:entityTypeName
    targetFilter:targetFilter
    scopeFilter:scopeFilter
    offset:offset
    limit:limit
              completionHandler: ^(Entities output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');

// Create an instance of the API class
var api = new TopologyExposureAndInventoryApi.EntitiesAndRelationshipsApi()
var accept = application/json; // {String} 
var domainName = RAN; // {String} domain name
var entityTypeName = entityTypeName_example; // {String} 
var opts = {
  'targetFilter': /sourceIds;/classifiers, // {String} Use *targetFilter* to specify what needs to be returned in the REST response.
  'scopeFilter': /sourceIds[contains(@item,'ManagedElement=1')], // {String} ScopeFilter is used to specify the conditions to be applied.
  'offset': 56, // {Integer} Pagination offset.
  'limit': 56 // {Integer} Result limiter.
};

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

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

            // Create an instance of the API class
            var apiInstance = new EntitiesAndRelationshipsApi();
            var accept = application/json;  // String |  (default to application/json)
            var domainName = RAN;  // String | domain name (default to null)
            var entityTypeName = entityTypeName_example;  // String |  (default to null)
            var targetFilter = /sourceIds;/classifiers;  // String | Use *targetFilter* to specify what needs to be returned in the REST response. (optional)  (default to null)
            var scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')];  // String | ScopeFilter is used to specify the conditions to be applied. (optional)  (default to null)
            var offset = 56;  // Integer | Pagination offset. (optional)  (default to 0)
            var limit = 56;  // Integer | Result limiter. (optional)  (default to 500)

            try {
                // Get all topology entities of a specific entity type.
                Entities result = apiInstance.getTopologyByEntityTypeName(accept, domainName, entityTypeName, targetFilter, scopeFilter, offset, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getTopologyByEntityTypeName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntitiesAndRelationshipsApi();
$accept = application/json; // String | 
$domainName = RAN; // String | domain name
$entityTypeName = entityTypeName_example; // String | 
$targetFilter = /sourceIds;/classifiers; // String | Use *targetFilter* to specify what needs to be returned in the REST response.
$scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String | ScopeFilter is used to specify the conditions to be applied.
$offset = 56; // Integer | Pagination offset.
$limit = 56; // Integer | Result limiter.

try {
    $result = $api_instance->getTopologyByEntityTypeName($accept, $domainName, $entityTypeName, $targetFilter, $scopeFilter, $offset, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntitiesAndRelationshipsApi->getTopologyByEntityTypeName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntitiesAndRelationshipsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntitiesAndRelationshipsApi->new();
my $accept = application/json; # String | 
my $domainName = RAN; # String | domain name
my $entityTypeName = entityTypeName_example; # String | 
my $targetFilter = /sourceIds;/classifiers; # String | Use *targetFilter* to specify what needs to be returned in the REST response.
my $scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; # String | ScopeFilter is used to specify the conditions to be applied.
my $offset = 56; # Integer | Pagination offset.
my $limit = 56; # Integer | Result limiter.

eval {
    my $result = $api_instance->getTopologyByEntityTypeName(accept => $accept, domainName => $domainName, entityTypeName => $entityTypeName, targetFilter => $targetFilter, scopeFilter => $scopeFilter, offset => $offset, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntitiesAndRelationshipsApi->getTopologyByEntityTypeName: $@\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.EntitiesAndRelationshipsApi()
accept = application/json # String |  (default to application/json)
domainName = RAN # String | domain name (default to null)
entityTypeName = entityTypeName_example # String |  (default to null)
targetFilter = /sourceIds;/classifiers # String | Use *targetFilter* to specify what needs to be returned in the REST response. (optional) (default to null)
scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')] # String | ScopeFilter is used to specify the conditions to be applied. (optional) (default to null)
offset = 56 # Integer | Pagination offset. (optional) (default to 0)
limit = 56 # Integer | Result limiter. (optional) (default to 500)

try:
    # Get all topology entities of a specific entity type.
    api_response = api_instance.get_topology_by_entity_type_name(accept, domainName, entityTypeName, targetFilter=targetFilter, scopeFilter=scopeFilter, offset=offset, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntitiesAndRelationshipsApi->getTopologyByEntityTypeName: %s\n" % e)
extern crate EntitiesAndRelationshipsApi;

pub fn main() {
    let accept = application/json; // String
    let domainName = RAN; // String
    let entityTypeName = entityTypeName_example; // String
    let targetFilter = /sourceIds;/classifiers; // String
    let scopeFilter = /sourceIds[contains(@item,'ManagedElement=1')]; // String
    let offset = 56; // Integer
    let limit = 56; // Integer

    let mut context = EntitiesAndRelationshipsApi::Context::default();
    let result = client.getTopologyByEntityTypeName(accept, domainName, entityTypeName, targetFilter, scopeFilter, offset, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
domainName*
String
domain name
Required
entityTypeName*
String
Required
Header parameters
Name Description
Accept*
String
Required
Query parameters
Name Description
targetFilter
String
Use *targetFilter* to specify what needs to be returned in the REST response.
scopeFilter
String
ScopeFilter is used to specify the conditions to be applied.
offset
Integer
Pagination offset.
limit
Integer
Result limiter.

Responses


getTopologyById

Get a specific Topology Entity instance of a Topology Entity type

Get a specific Topology Entity instance of a Topology Entity type


/domains/{domainName}/entity-types/{entityTypeName}/entities/{entityId}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/yang.data+json,application/problem+json" \
 "https://localhost/topology-inventory/v1/domains/{domainName}/entity-types/{entityTypeName}/entities/{entityId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntitiesAndRelationshipsApi;

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

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

        // Create an instance of the API class
        EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
        String accept = application/yang.data+json; // String | 
        String domainName = RAN; // String | domain name
        String entityTypeName = entityTypeName_example; // String | 
        String entityId = entityId_example; // String | 

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

final api_instance = DefaultApi();

final String accept = new String(); // String | 
final String domainName = new String(); // String | domain name
final String entityTypeName = new String(); // String | 
final String entityId = new String(); // String | 

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

import org.openapitools.client.api.EntitiesAndRelationshipsApi;

public class EntitiesAndRelationshipsApiExample {
    public static void main(String[] args) {
        EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
        String accept = application/yang.data+json; // String | 
        String domainName = RAN; // String | domain name
        String entityTypeName = entityTypeName_example; // String | 
        String entityId = entityId_example; // String | 

        try {
            Object result = apiInstance.getTopologyById(accept, domainName, entityTypeName, entityId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntitiesAndRelationshipsApi *apiInstance = [[EntitiesAndRelationshipsApi alloc] init];
String *accept = application/yang.data+json; //  (default to application/yang.data+json)
String *domainName = RAN; // domain name (default to null)
String *entityTypeName = entityTypeName_example; //  (default to null)
String *entityId = entityId_example; //  (default to null)

// Get a specific Topology Entity instance of a Topology Entity type
[apiInstance getTopologyByIdWith:accept
    domainName:domainName
    entityTypeName:entityTypeName
    entityId:entityId
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');

// Create an instance of the API class
var api = new TopologyExposureAndInventoryApi.EntitiesAndRelationshipsApi()
var accept = application/yang.data+json; // {String} 
var domainName = RAN; // {String} domain name
var entityTypeName = entityTypeName_example; // {String} 
var entityId = entityId_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new EntitiesAndRelationshipsApi();
            var accept = application/yang.data+json;  // String |  (default to application/yang.data+json)
            var domainName = RAN;  // String | domain name (default to null)
            var entityTypeName = entityTypeName_example;  // String |  (default to null)
            var entityId = entityId_example;  // String |  (default to null)

            try {
                // Get a specific Topology Entity instance of a Topology Entity type
                Object result = apiInstance.getTopologyById(accept, domainName, entityTypeName, entityId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getTopologyById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntitiesAndRelationshipsApi();
$accept = application/yang.data+json; // String | 
$domainName = RAN; // String | domain name
$entityTypeName = entityTypeName_example; // String | 
$entityId = entityId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntitiesAndRelationshipsApi->new();
my $accept = application/yang.data+json; # String | 
my $domainName = RAN; # String | domain name
my $entityTypeName = entityTypeName_example; # String | 
my $entityId = entityId_example; # String | 

eval {
    my $result = $api_instance->getTopologyById(accept => $accept, domainName => $domainName, entityTypeName => $entityTypeName, entityId => $entityId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntitiesAndRelationshipsApi->getTopologyById: $@\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.EntitiesAndRelationshipsApi()
accept = application/yang.data+json # String |  (default to application/yang.data+json)
domainName = RAN # String | domain name (default to null)
entityTypeName = entityTypeName_example # String |  (default to null)
entityId = entityId_example # String |  (default to null)

try:
    # Get a specific Topology Entity instance of a Topology Entity type
    api_response = api_instance.get_topology_by_id(accept, domainName, entityTypeName, entityId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntitiesAndRelationshipsApi->getTopologyById: %s\n" % e)
extern crate EntitiesAndRelationshipsApi;

pub fn main() {
    let accept = application/yang.data+json; // String
    let domainName = RAN; // String
    let entityTypeName = entityTypeName_example; // String
    let entityId = entityId_example; // String

    let mut context = EntitiesAndRelationshipsApi::Context::default();
    let result = client.getTopologyById(accept, domainName, entityTypeName, entityId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
domainName*
String
domain name
Required
entityTypeName*
String
Required
entityId*
String
Required
Header parameters
Name Description
Accept*
String
Required

Responses


getTopologyEntityTypes

Get all the available topology entity types in domain name.

Get all the available topology entity types in domain name.


/domains/{domainName}/entity-types

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://localhost/topology-inventory/v1/domains/{domainName}/entity-types?offset=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntitiesAndRelationshipsApi;

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

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

        // Create an instance of the API class
        EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
        String accept = application/json; // String | 
        String domainName = RAN; // String | domain name
        Integer offset = 56; // Integer | Pagination offset.
        Integer limit = 56; // Integer | Result limiter.

        try {
            EntityTypes result = apiInstance.getTopologyEntityTypes(accept, domainName, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyEntityTypes");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String accept = new String(); // String | 
final String domainName = new String(); // String | domain name
final Integer offset = new Integer(); // Integer | Pagination offset.
final Integer limit = new Integer(); // Integer | Result limiter.

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

import org.openapitools.client.api.EntitiesAndRelationshipsApi;

public class EntitiesAndRelationshipsApiExample {
    public static void main(String[] args) {
        EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
        String accept = application/json; // String | 
        String domainName = RAN; // String | domain name
        Integer offset = 56; // Integer | Pagination offset.
        Integer limit = 56; // Integer | Result limiter.

        try {
            EntityTypes result = apiInstance.getTopologyEntityTypes(accept, domainName, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyEntityTypes");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntitiesAndRelationshipsApi *apiInstance = [[EntitiesAndRelationshipsApi alloc] init];
String *accept = application/json; //  (default to application/json)
String *domainName = RAN; // domain name (default to null)
Integer *offset = 56; // Pagination offset. (optional) (default to 0)
Integer *limit = 56; // Result limiter. (optional) (default to 500)

// Get all the available topology entity types in domain name.
[apiInstance getTopologyEntityTypesWith:accept
    domainName:domainName
    offset:offset
    limit:limit
              completionHandler: ^(EntityTypes output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');

// Create an instance of the API class
var api = new TopologyExposureAndInventoryApi.EntitiesAndRelationshipsApi()
var accept = application/json; // {String} 
var domainName = RAN; // {String} domain name
var opts = {
  'offset': 56, // {Integer} Pagination offset.
  'limit': 56 // {Integer} Result limiter.
};

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

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

            // Create an instance of the API class
            var apiInstance = new EntitiesAndRelationshipsApi();
            var accept = application/json;  // String |  (default to application/json)
            var domainName = RAN;  // String | domain name (default to null)
            var offset = 56;  // Integer | Pagination offset. (optional)  (default to 0)
            var limit = 56;  // Integer | Result limiter. (optional)  (default to 500)

            try {
                // Get all the available topology entity types in domain name.
                EntityTypes result = apiInstance.getTopologyEntityTypes(accept, domainName, offset, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getTopologyEntityTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntitiesAndRelationshipsApi();
$accept = application/json; // String | 
$domainName = RAN; // String | domain name
$offset = 56; // Integer | Pagination offset.
$limit = 56; // Integer | Result limiter.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntitiesAndRelationshipsApi->new();
my $accept = application/json; # String | 
my $domainName = RAN; # String | domain name
my $offset = 56; # Integer | Pagination offset.
my $limit = 56; # Integer | Result limiter.

eval {
    my $result = $api_instance->getTopologyEntityTypes(accept => $accept, domainName => $domainName, offset => $offset, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntitiesAndRelationshipsApi->getTopologyEntityTypes: $@\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.EntitiesAndRelationshipsApi()
accept = application/json # String |  (default to application/json)
domainName = RAN # String | domain name (default to null)
offset = 56 # Integer | Pagination offset. (optional) (default to 0)
limit = 56 # Integer | Result limiter. (optional) (default to 500)

try:
    # Get all the available topology entity types in domain name.
    api_response = api_instance.get_topology_entity_types(accept, domainName, offset=offset, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntitiesAndRelationshipsApi->getTopologyEntityTypes: %s\n" % e)
extern crate EntitiesAndRelationshipsApi;

pub fn main() {
    let accept = application/json; // String
    let domainName = RAN; // String
    let offset = 56; // Integer
    let limit = 56; // Integer

    let mut context = EntitiesAndRelationshipsApi::Context::default();
    let result = client.getTopologyEntityTypes(accept, domainName, offset, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
domainName*
String
domain name
Required
Header parameters
Name Description
Accept*
String
Required
Query parameters
Name Description
offset
Integer
Pagination offset.
limit
Integer
Result limiter.

Responses


getTopologyRelationshipTypes

Get all the available topology relationship types.

Get all the available Topology Relationship types.


/domains/{domainName}/relationship-types

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://localhost/topology-inventory/v1/domains/{domainName}/relationship-types?offset=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntitiesAndRelationshipsApi;

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

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

        // Create an instance of the API class
        EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
        String accept = application/json; // String | 
        String domainName = RAN; // String | domain name
        Integer offset = 56; // Integer | Pagination offset.
        Integer limit = 56; // Integer | Result limiter.

        try {
            RelationshipTypes result = apiInstance.getTopologyRelationshipTypes(accept, domainName, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyRelationshipTypes");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String accept = new String(); // String | 
final String domainName = new String(); // String | domain name
final Integer offset = new Integer(); // Integer | Pagination offset.
final Integer limit = new Integer(); // Integer | Result limiter.

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

import org.openapitools.client.api.EntitiesAndRelationshipsApi;

public class EntitiesAndRelationshipsApiExample {
    public static void main(String[] args) {
        EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
        String accept = application/json; // String | 
        String domainName = RAN; // String | domain name
        Integer offset = 56; // Integer | Pagination offset.
        Integer limit = 56; // Integer | Result limiter.

        try {
            RelationshipTypes result = apiInstance.getTopologyRelationshipTypes(accept, domainName, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyRelationshipTypes");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntitiesAndRelationshipsApi *apiInstance = [[EntitiesAndRelationshipsApi alloc] init];
String *accept = application/json; //  (default to application/json)
String *domainName = RAN; // domain name (default to null)
Integer *offset = 56; // Pagination offset. (optional) (default to 0)
Integer *limit = 56; // Result limiter. (optional) (default to 500)

// Get all the available topology relationship types.
[apiInstance getTopologyRelationshipTypesWith:accept
    domainName:domainName
    offset:offset
    limit:limit
              completionHandler: ^(RelationshipTypes output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');

// Create an instance of the API class
var api = new TopologyExposureAndInventoryApi.EntitiesAndRelationshipsApi()
var accept = application/json; // {String} 
var domainName = RAN; // {String} domain name
var opts = {
  'offset': 56, // {Integer} Pagination offset.
  'limit': 56 // {Integer} Result limiter.
};

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

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

            // Create an instance of the API class
            var apiInstance = new EntitiesAndRelationshipsApi();
            var accept = application/json;  // String |  (default to application/json)
            var domainName = RAN;  // String | domain name (default to null)
            var offset = 56;  // Integer | Pagination offset. (optional)  (default to 0)
            var limit = 56;  // Integer | Result limiter. (optional)  (default to 500)

            try {
                // Get all the available topology relationship types.
                RelationshipTypes result = apiInstance.getTopologyRelationshipTypes(accept, domainName, offset, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getTopologyRelationshipTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntitiesAndRelationshipsApi();
$accept = application/json; // String | 
$domainName = RAN; // String | domain name
$offset = 56; // Integer | Pagination offset.
$limit = 56; // Integer | Result limiter.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntitiesAndRelationshipsApi->new();
my $accept = application/json; # String | 
my $domainName = RAN; # String | domain name
my $offset = 56; # Integer | Pagination offset.
my $limit = 56; # Integer | Result limiter.

eval {
    my $result = $api_instance->getTopologyRelationshipTypes(accept => $accept, domainName => $domainName, offset => $offset, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntitiesAndRelationshipsApi->getTopologyRelationshipTypes: $@\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.EntitiesAndRelationshipsApi()
accept = application/json # String |  (default to application/json)
domainName = RAN # String | domain name (default to null)
offset = 56 # Integer | Pagination offset. (optional) (default to 0)
limit = 56 # Integer | Result limiter. (optional) (default to 500)

try:
    # Get all the available topology relationship types.
    api_response = api_instance.get_topology_relationship_types(accept, domainName, offset=offset, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntitiesAndRelationshipsApi->getTopologyRelationshipTypes: %s\n" % e)
extern crate EntitiesAndRelationshipsApi;

pub fn main() {
    let accept = application/json; // String
    let domainName = RAN; // String
    let offset = 56; // Integer
    let limit = 56; // Integer

    let mut context = EntitiesAndRelationshipsApi::Context::default();
    let result = client.getTopologyRelationshipTypes(accept, domainName, offset, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
domainName*
String
domain name
Required
Header parameters
Name Description
Accept*
String
Required
Query parameters
Name Description
offset
Integer
Pagination offset.
limit
Integer
Result limiter.

Responses


Groups

createGroup

Create a new group.

Create a group of entities and/or relationships in a static or dynamic way.


/groups

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json,application/problem+json" \
 -H "Content-Type: application/json" \
 "https://localhost/topology-inventory/v1/groups" \
 -d '{
  "name" : "name",
  "providedMembers" : [ "{}", "{}" ],
  "type" : "type"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GroupsApi;

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

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

        // Create an instance of the API class
        GroupsApi apiInstance = new GroupsApi();
        String accept = application/json; // String | 
        String contentType = application/json; // String | 
        CreateGroupPayload createGroupPayload = ; // CreateGroupPayload | 

        try {
            GroupByIdResponse result = apiInstance.createGroup(accept, contentType, createGroupPayload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#createGroup");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String accept = new String(); // String | 
final String contentType = new String(); // String | 
final CreateGroupPayload createGroupPayload = new CreateGroupPayload(); // CreateGroupPayload | 

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

import org.openapitools.client.api.GroupsApi;

public class GroupsApiExample {
    public static void main(String[] args) {
        GroupsApi apiInstance = new GroupsApi();
        String accept = application/json; // String | 
        String contentType = application/json; // String | 
        CreateGroupPayload createGroupPayload = ; // CreateGroupPayload | 

        try {
            GroupByIdResponse result = apiInstance.createGroup(accept, contentType, createGroupPayload);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#createGroup");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GroupsApi *apiInstance = [[GroupsApi alloc] init];
String *accept = application/json; //  (default to application/json)
String *contentType = application/json; //  (default to application/json)
CreateGroupPayload *createGroupPayload = ; // 

// Create a new group.
[apiInstance createGroupWith:accept
    contentType:contentType
    createGroupPayload:createGroupPayload
              completionHandler: ^(GroupByIdResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');

// Create an instance of the API class
var api = new TopologyExposureAndInventoryApi.GroupsApi()
var accept = application/json; // {String} 
var contentType = application/json; // {String} 
var createGroupPayload = ; // {CreateGroupPayload} 

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

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

            // Create an instance of the API class
            var apiInstance = new GroupsApi();
            var accept = application/json;  // String |  (default to application/json)
            var contentType = application/json;  // String |  (default to application/json)
            var createGroupPayload = new CreateGroupPayload(); // CreateGroupPayload | 

            try {
                // Create a new group.
                GroupByIdResponse result = apiInstance.createGroup(accept, contentType, createGroupPayload);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GroupsApi.createGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GroupsApi();
$accept = application/json; // String | 
$contentType = application/json; // String | 
$createGroupPayload = ; // CreateGroupPayload | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GroupsApi->new();
my $accept = application/json; # String | 
my $contentType = application/json; # String | 
my $createGroupPayload = WWW::OPenAPIClient::Object::CreateGroupPayload->new(); # CreateGroupPayload | 

eval {
    my $result = $api_instance->createGroup(accept => $accept, contentType => $contentType, createGroupPayload => $createGroupPayload);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupsApi->createGroup: $@\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.GroupsApi()
accept = application/json # String |  (default to application/json)
contentType = application/json # String |  (default to application/json)
createGroupPayload =  # CreateGroupPayload | 

try:
    # Create a new group.
    api_response = api_instance.create_group(accept, contentType, createGroupPayload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupsApi->createGroup: %s\n" % e)
extern crate GroupsApi;

pub fn main() {
    let accept = application/json; // String
    let contentType = application/json; // String
    let createGroupPayload = ; // CreateGroupPayload

    let mut context = GroupsApi::Context::default();
    let result = client.createGroup(accept, contentType, createGroupPayload, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
Accept*
String
Required
Content-Type*
String
Required
Body parameters
Name Description
createGroupPayload *

Responses


deleteGroup

Delete a group with specified id.

Delete a group with specified id.


/groups/{groupId}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/problem+json" \
 "https://localhost/topology-inventory/v1/groups/{groupId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GroupsApi;

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

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

        // Create an instance of the API class
        GroupsApi apiInstance = new GroupsApi();
        String groupId = groupId_example; // String | 

        try {
            apiInstance.deleteGroup(groupId);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#deleteGroup");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String groupId = new String(); // String | 

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

import org.openapitools.client.api.GroupsApi;

public class GroupsApiExample {
    public static void main(String[] args) {
        GroupsApi apiInstance = new GroupsApi();
        String groupId = groupId_example; // String | 

        try {
            apiInstance.deleteGroup(groupId);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#deleteGroup");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GroupsApi *apiInstance = [[GroupsApi alloc] init];
String *groupId = groupId_example; //  (default to null)

// Delete a group with specified id.
[apiInstance deleteGroupWith:groupId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');

// Create an instance of the API class
var api = new TopologyExposureAndInventoryApi.GroupsApi()
var groupId = groupId_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new GroupsApi();
            var groupId = groupId_example;  // String |  (default to null)

            try {
                // Delete a group with specified id.
                apiInstance.deleteGroup(groupId);
            } catch (Exception e) {
                Debug.Print("Exception when calling GroupsApi.deleteGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GroupsApi();
$groupId = groupId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GroupsApi->new();
my $groupId = groupId_example; # String | 

eval {
    $api_instance->deleteGroup(groupId => $groupId);
};
if ($@) {
    warn "Exception when calling GroupsApi->deleteGroup: $@\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.GroupsApi()
groupId = groupId_example # String |  (default to null)

try:
    # Delete a group with specified id.
    api_instance.delete_group(groupId)
except ApiException as e:
    print("Exception when calling GroupsApi->deleteGroup: %s\n" % e)
extern crate GroupsApi;

pub fn main() {
    let groupId = groupId_example; // String

    let mut context = GroupsApi::Context::default();
    let result = client.deleteGroup(groupId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
groupId*
String
Required

Responses


getAllGroups

Get all groups.

Get all groups.


/groups

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://localhost/topology-inventory/v1/groups?offset=56&limit=56&name=name_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GroupsApi;

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

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

        // Create an instance of the API class
        GroupsApi apiInstance = new GroupsApi();
        String accept = application/json; // String | 
        Integer offset = 56; // Integer | Pagination offset.
        Integer limit = 56; // Integer | Result limiter.
        String name = name_example; // String | Group name. If not specified, returns all the groups.

        try {
            GroupsResponse result = apiInstance.getAllGroups(accept, offset, limit, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#getAllGroups");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String accept = new String(); // String | 
final Integer offset = new Integer(); // Integer | Pagination offset.
final Integer limit = new Integer(); // Integer | Result limiter.
final String name = new String(); // String | Group name. If not specified, returns all the groups.

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

import org.openapitools.client.api.GroupsApi;

public class GroupsApiExample {
    public static void main(String[] args) {
        GroupsApi apiInstance = new GroupsApi();
        String accept = application/json; // String | 
        Integer offset = 56; // Integer | Pagination offset.
        Integer limit = 56; // Integer | Result limiter.
        String name = name_example; // String | Group name. If not specified, returns all the groups.

        try {
            GroupsResponse result = apiInstance.getAllGroups(accept, offset, limit, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#getAllGroups");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GroupsApi *apiInstance = [[GroupsApi alloc] init];
String *accept = application/json; //  (default to application/json)
Integer *offset = 56; // Pagination offset. (optional) (default to 0)
Integer *limit = 56; // Result limiter. (optional) (default to 500)
String *name = name_example; // Group name. If not specified, returns all the groups. (optional) (default to null)

// Get all groups.
[apiInstance getAllGroupsWith:accept
    offset:offset
    limit:limit
    name:name
              completionHandler: ^(GroupsResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');

// Create an instance of the API class
var api = new TopologyExposureAndInventoryApi.GroupsApi()
var accept = application/json; // {String} 
var opts = {
  'offset': 56, // {Integer} Pagination offset.
  'limit': 56, // {Integer} Result limiter.
  'name': name_example // {String} Group name. If not specified, returns all the groups.
};

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

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

            // Create an instance of the API class
            var apiInstance = new GroupsApi();
            var accept = application/json;  // String |  (default to application/json)
            var offset = 56;  // Integer | Pagination offset. (optional)  (default to 0)
            var limit = 56;  // Integer | Result limiter. (optional)  (default to 500)
            var name = name_example;  // String | Group name. If not specified, returns all the groups. (optional)  (default to null)

            try {
                // Get all groups.
                GroupsResponse result = apiInstance.getAllGroups(accept, offset, limit, name);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GroupsApi.getAllGroups: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GroupsApi();
$accept = application/json; // String | 
$offset = 56; // Integer | Pagination offset.
$limit = 56; // Integer | Result limiter.
$name = name_example; // String | Group name. If not specified, returns all the groups.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GroupsApi->new();
my $accept = application/json; # String | 
my $offset = 56; # Integer | Pagination offset.
my $limit = 56; # Integer | Result limiter.
my $name = name_example; # String | Group name. If not specified, returns all the groups.

eval {
    my $result = $api_instance->getAllGroups(accept => $accept, offset => $offset, limit => $limit, name => $name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupsApi->getAllGroups: $@\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.GroupsApi()
accept = application/json # String |  (default to application/json)
offset = 56 # Integer | Pagination offset. (optional) (default to 0)
limit = 56 # Integer | Result limiter. (optional) (default to 500)
name = name_example # String | Group name. If not specified, returns all the groups. (optional) (default to null)

try:
    # Get all groups.
    api_response = api_instance.get_all_groups(accept, offset=offset, limit=limit, name=name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupsApi->getAllGroups: %s\n" % e)
extern crate GroupsApi;

pub fn main() {
    let accept = application/json; // String
    let offset = 56; // Integer
    let limit = 56; // Integer
    let name = name_example; // String

    let mut context = GroupsApi::Context::default();
    let result = client.getAllGroups(accept, offset, limit, name, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
Accept*
String
Required
Query parameters
Name Description
offset
Integer
Pagination offset.
limit
Integer
Result limiter.
name
String
Group name. If not specified, returns all the groups.

Responses


getGroupById

Get a group with specified id.

Get a group with specified id.


/groups/{groupId}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://localhost/topology-inventory/v1/groups/{groupId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GroupsApi;

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

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

        // Create an instance of the API class
        GroupsApi apiInstance = new GroupsApi();
        String accept = application/json; // String | 
        String groupId = groupId_example; // String | 

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

final api_instance = DefaultApi();

final String accept = new String(); // String | 
final String groupId = new String(); // String | 

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

import org.openapitools.client.api.GroupsApi;

public class GroupsApiExample {
    public static void main(String[] args) {
        GroupsApi apiInstance = new GroupsApi();
        String accept = application/json; // String | 
        String groupId = groupId_example; // String | 

        try {
            GroupByIdResponse result = apiInstance.getGroupById(accept, groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#getGroupById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GroupsApi *apiInstance = [[GroupsApi alloc] init];
String *accept = application/json; //  (default to application/json)
String *groupId = groupId_example; //  (default to null)

// Get a group with specified id.
[apiInstance getGroupByIdWith:accept
    groupId:groupId
              completionHandler: ^(GroupByIdResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');

// Create an instance of the API class
var api = new TopologyExposureAndInventoryApi.GroupsApi()
var accept = application/json; // {String} 
var groupId = groupId_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new GroupsApi();
            var accept = application/json;  // String |  (default to application/json)
            var groupId = groupId_example;  // String |  (default to null)

            try {
                // Get a group with specified id.
                GroupByIdResponse result = apiInstance.getGroupById(accept, groupId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GroupsApi.getGroupById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GroupsApi();
$accept = application/json; // String | 
$groupId = groupId_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GroupsApi->new();
my $accept = application/json; # String | 
my $groupId = groupId_example; # String | 

eval {
    my $result = $api_instance->getGroupById(accept => $accept, groupId => $groupId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupsApi->getGroupById: $@\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.GroupsApi()
accept = application/json # String |  (default to application/json)
groupId = groupId_example # String |  (default to null)

try:
    # Get a group with specified id.
    api_response = api_instance.get_group_by_id(accept, groupId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupsApi->getGroupById: %s\n" % e)
extern crate GroupsApi;

pub fn main() {
    let accept = application/json; // String
    let groupId = groupId_example; // String

    let mut context = GroupsApi::Context::default();
    let result = client.getGroupById(accept, groupId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
groupId*
String
Required
Header parameters
Name Description
Accept*
String
Required

Responses


getMembers

Get the members of a group with specified id.

Get the members of a group with specified id.


/groups/{groupId}/members

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://localhost/topology-inventory/v1/groups/{groupId}/members?offset=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GroupsApi;

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

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

        // Create an instance of the API class
        GroupsApi apiInstance = new GroupsApi();
        String accept = application/json; // String | 
        String groupId = groupId_example; // String | 
        Integer offset = 56; // Integer | Pagination offset.
        Integer limit = 56; // Integer | Result limiter.

        try {
            MembersResponse result = apiInstance.getMembers(accept, groupId, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#getMembers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String accept = new String(); // String | 
final String groupId = new String(); // String | 
final Integer offset = new Integer(); // Integer | Pagination offset.
final Integer limit = new Integer(); // Integer | Result limiter.

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

import org.openapitools.client.api.GroupsApi;

public class GroupsApiExample {
    public static void main(String[] args) {
        GroupsApi apiInstance = new GroupsApi();
        String accept = application/json; // String | 
        String groupId = groupId_example; // String | 
        Integer offset = 56; // Integer | Pagination offset.
        Integer limit = 56; // Integer | Result limiter.

        try {
            MembersResponse result = apiInstance.getMembers(accept, groupId, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#getMembers");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GroupsApi *apiInstance = [[GroupsApi alloc] init];
String *accept = application/json; //  (default to application/json)
String *groupId = groupId_example; //  (default to null)
Integer *offset = 56; // Pagination offset. (optional) (default to 0)
Integer *limit = 56; // Result limiter. (optional) (default to 500)

// Get the members of a group with specified id.
[apiInstance getMembersWith:accept
    groupId:groupId
    offset:offset
    limit:limit
              completionHandler: ^(MembersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');

// Create an instance of the API class
var api = new TopologyExposureAndInventoryApi.GroupsApi()
var accept = application/json; // {String} 
var groupId = groupId_example; // {String} 
var opts = {
  'offset': 56, // {Integer} Pagination offset.
  'limit': 56 // {Integer} Result limiter.
};

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

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

            // Create an instance of the API class
            var apiInstance = new GroupsApi();
            var accept = application/json;  // String |  (default to application/json)
            var groupId = groupId_example;  // String |  (default to null)
            var offset = 56;  // Integer | Pagination offset. (optional)  (default to 0)
            var limit = 56;  // Integer | Result limiter. (optional)  (default to 500)

            try {
                // Get the members of a group with specified id.
                MembersResponse result = apiInstance.getMembers(accept, groupId, offset, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GroupsApi.getMembers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GroupsApi();
$accept = application/json; // String | 
$groupId = groupId_example; // String | 
$offset = 56; // Integer | Pagination offset.
$limit = 56; // Integer | Result limiter.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GroupsApi->new();
my $accept = application/json; # String | 
my $groupId = groupId_example; # String | 
my $offset = 56; # Integer | Pagination offset.
my $limit = 56; # Integer | Result limiter.

eval {
    my $result = $api_instance->getMembers(accept => $accept, groupId => $groupId, offset => $offset, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupsApi->getMembers: $@\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.GroupsApi()
accept = application/json # String |  (default to application/json)
groupId = groupId_example # String |  (default to null)
offset = 56 # Integer | Pagination offset. (optional) (default to 0)
limit = 56 # Integer | Result limiter. (optional) (default to 500)

try:
    # Get the members of a group with specified id.
    api_response = api_instance.get_members(accept, groupId, offset=offset, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupsApi->getMembers: %s\n" % e)
extern crate GroupsApi;

pub fn main() {
    let accept = application/json; // String
    let groupId = groupId_example; // String
    let offset = 56; // Integer
    let limit = 56; // Integer

    let mut context = GroupsApi::Context::default();
    let result = client.getMembers(accept, groupId, offset, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
groupId*
String
Required
Header parameters
Name Description
Accept*
String
Required
Query parameters
Name Description
offset
Integer
Pagination offset.
limit
Integer
Result limiter.

Responses


getProvidedMembers

Get the provided members of a static group with specified id.

Get the provided members of a static group with specified id.


/groups/{groupId}/provided-members

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://localhost/topology-inventory/v1/groups/{groupId}/provided-members?status=status_example&offset=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GroupsApi;

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

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

        // Create an instance of the API class
        GroupsApi apiInstance = new GroupsApi();
        String accept = application/json; // String | 
        String groupId = groupId_example; // String | 
        String status = status_example; // String | Status can be present (or) not-present (or) invalid. If not specified, returns all members of the group.
        Integer offset = 56; // Integer | Pagination offset.
        Integer limit = 56; // Integer | Result limiter.

        try {
            MembersResponse result = apiInstance.getProvidedMembers(accept, groupId, status, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#getProvidedMembers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String accept = new String(); // String | 
final String groupId = new String(); // String | 
final String status = new String(); // String | Status can be present (or) not-present (or) invalid. If not specified, returns all members of the group.
final Integer offset = new Integer(); // Integer | Pagination offset.
final Integer limit = new Integer(); // Integer | Result limiter.

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

import org.openapitools.client.api.GroupsApi;

public class GroupsApiExample {
    public static void main(String[] args) {
        GroupsApi apiInstance = new GroupsApi();
        String accept = application/json; // String | 
        String groupId = groupId_example; // String | 
        String status = status_example; // String | Status can be present (or) not-present (or) invalid. If not specified, returns all members of the group.
        Integer offset = 56; // Integer | Pagination offset.
        Integer limit = 56; // Integer | Result limiter.

        try {
            MembersResponse result = apiInstance.getProvidedMembers(accept, groupId, status, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#getProvidedMembers");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GroupsApi *apiInstance = [[GroupsApi alloc] init];
String *accept = application/json; //  (default to application/json)
String *groupId = groupId_example; //  (default to null)
String *status = status_example; // Status can be present (or) not-present (or) invalid. If not specified, returns all members of the group. (optional) (default to null)
Integer *offset = 56; // Pagination offset. (optional) (default to 0)
Integer *limit = 56; // Result limiter. (optional) (default to 500)

// Get the provided members of a static group with specified id.
[apiInstance getProvidedMembersWith:accept
    groupId:groupId
    status:status
    offset:offset
    limit:limit
              completionHandler: ^(MembersResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');

// Create an instance of the API class
var api = new TopologyExposureAndInventoryApi.GroupsApi()
var accept = application/json; // {String} 
var groupId = groupId_example; // {String} 
var opts = {
  'status': status_example, // {String} Status can be present (or) not-present (or) invalid. If not specified, returns all members of the group.
  'offset': 56, // {Integer} Pagination offset.
  'limit': 56 // {Integer} Result limiter.
};

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

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

            // Create an instance of the API class
            var apiInstance = new GroupsApi();
            var accept = application/json;  // String |  (default to application/json)
            var groupId = groupId_example;  // String |  (default to null)
            var status = status_example;  // String | Status can be present (or) not-present (or) invalid. If not specified, returns all members of the group. (optional)  (default to null)
            var offset = 56;  // Integer | Pagination offset. (optional)  (default to 0)
            var limit = 56;  // Integer | Result limiter. (optional)  (default to 500)

            try {
                // Get the provided members of a static group with specified id.
                MembersResponse result = apiInstance.getProvidedMembers(accept, groupId, status, offset, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GroupsApi.getProvidedMembers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GroupsApi();
$accept = application/json; // String | 
$groupId = groupId_example; // String | 
$status = status_example; // String | Status can be present (or) not-present (or) invalid. If not specified, returns all members of the group.
$offset = 56; // Integer | Pagination offset.
$limit = 56; // Integer | Result limiter.

try {
    $result = $api_instance->getProvidedMembers($accept, $groupId, $status, $offset, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->getProvidedMembers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GroupsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GroupsApi->new();
my $accept = application/json; # String | 
my $groupId = groupId_example; # String | 
my $status = status_example; # String | Status can be present (or) not-present (or) invalid. If not specified, returns all members of the group.
my $offset = 56; # Integer | Pagination offset.
my $limit = 56; # Integer | Result limiter.

eval {
    my $result = $api_instance->getProvidedMembers(accept => $accept, groupId => $groupId, status => $status, offset => $offset, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GroupsApi->getProvidedMembers: $@\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.GroupsApi()
accept = application/json # String |  (default to application/json)
groupId = groupId_example # String |  (default to null)
status = status_example # String | Status can be present (or) not-present (or) invalid. If not specified, returns all members of the group. (optional) (default to null)
offset = 56 # Integer | Pagination offset. (optional) (default to 0)
limit = 56 # Integer | Result limiter. (optional) (default to 500)

try:
    # Get the provided members of a static group with specified id.
    api_response = api_instance.get_provided_members(accept, groupId, status=status, offset=offset, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GroupsApi->getProvidedMembers: %s\n" % e)
extern crate GroupsApi;

pub fn main() {
    let accept = application/json; // String
    let groupId = groupId_example; // String
    let status = status_example; // String
    let offset = 56; // Integer
    let limit = 56; // Integer

    let mut context = GroupsApi::Context::default();
    let result = client.getProvidedMembers(accept, groupId, status, offset, limit, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
groupId*
String
Required
Header parameters
Name Description
Accept*
String
Required
Query parameters
Name Description
status
String
Status can be present (or) not-present (or) invalid. If not specified, returns all members of the group.
offset
Integer
Pagination offset.
limit
Integer
Result limiter.

Responses


updateGroupName

Update the name of a group.

Update the name of a group.


/groups/{groupId}/name

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/problem+json" \
 -H "Content-Type: application/json" \
 "https://localhost/topology-inventory/v1/groups/{groupId}/name" \
 -d '{
  "name" : "name"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GroupsApi;

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

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

        // Create an instance of the API class
        GroupsApi apiInstance = new GroupsApi();
        String contentType = application/json; // String | 
        String groupId = groupId_example; // String | 
        UpdateGroupNamePayload updateGroupNamePayload = ; // UpdateGroupNamePayload | 

        try {
            apiInstance.updateGroupName(contentType, groupId, updateGroupNamePayload);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#updateGroupName");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String contentType = new String(); // String | 
final String groupId = new String(); // String | 
final UpdateGroupNamePayload updateGroupNamePayload = new UpdateGroupNamePayload(); // UpdateGroupNamePayload | 

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

import org.openapitools.client.api.GroupsApi;

public class GroupsApiExample {
    public static void main(String[] args) {
        GroupsApi apiInstance = new GroupsApi();
        String contentType = application/json; // String | 
        String groupId = groupId_example; // String | 
        UpdateGroupNamePayload updateGroupNamePayload = ; // UpdateGroupNamePayload | 

        try {
            apiInstance.updateGroupName(contentType, groupId, updateGroupNamePayload);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#updateGroupName");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GroupsApi *apiInstance = [[GroupsApi alloc] init];
String *contentType = application/json; //  (default to application/json)
String *groupId = groupId_example; //  (default to null)
UpdateGroupNamePayload *updateGroupNamePayload = ; // 

// Update the name of a group.
[apiInstance updateGroupNameWith:contentType
    groupId:groupId
    updateGroupNamePayload:updateGroupNamePayload
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');

// Create an instance of the API class
var api = new TopologyExposureAndInventoryApi.GroupsApi()
var contentType = application/json; // {String} 
var groupId = groupId_example; // {String} 
var updateGroupNamePayload = ; // {UpdateGroupNamePayload} 

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

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

            // Create an instance of the API class
            var apiInstance = new GroupsApi();
            var contentType = application/json;  // String |  (default to application/json)
            var groupId = groupId_example;  // String |  (default to null)
            var updateGroupNamePayload = new UpdateGroupNamePayload(); // UpdateGroupNamePayload | 

            try {
                // Update the name of a group.
                apiInstance.updateGroupName(contentType, groupId, updateGroupNamePayload);
            } catch (Exception e) {
                Debug.Print("Exception when calling GroupsApi.updateGroupName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GroupsApi();
$contentType = application/json; // String | 
$groupId = groupId_example; // String | 
$updateGroupNamePayload = ; // UpdateGroupNamePayload | 

try {
    $api_instance->updateGroupName($contentType, $groupId, $updateGroupNamePayload);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->updateGroupName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GroupsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GroupsApi->new();
my $contentType = application/json; # String | 
my $groupId = groupId_example; # String | 
my $updateGroupNamePayload = WWW::OPenAPIClient::Object::UpdateGroupNamePayload->new(); # UpdateGroupNamePayload | 

eval {
    $api_instance->updateGroupName(contentType => $contentType, groupId => $groupId, updateGroupNamePayload => $updateGroupNamePayload);
};
if ($@) {
    warn "Exception when calling GroupsApi->updateGroupName: $@\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.GroupsApi()
contentType = application/json # String |  (default to application/json)
groupId = groupId_example # String |  (default to null)
updateGroupNamePayload =  # UpdateGroupNamePayload | 

try:
    # Update the name of a group.
    api_instance.update_group_name(contentType, groupId, updateGroupNamePayload)
except ApiException as e:
    print("Exception when calling GroupsApi->updateGroupName: %s\n" % e)
extern crate GroupsApi;

pub fn main() {
    let contentType = application/json; // String
    let groupId = groupId_example; // String
    let updateGroupNamePayload = ; // UpdateGroupNamePayload

    let mut context = GroupsApi::Context::default();
    let result = client.updateGroupName(contentType, groupId, updateGroupNamePayload, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
groupId*
String
Required
Header parameters
Name Description
Content-Type*
String
Required
Body parameters
Name Description
updateGroupNamePayload *

Responses


updateProvidedMembers

Merge or remove members of a static group.

Merge or remove members in an existing topology group. This operation is applicable for static group only.


/groups/{groupId}/provided-members-operations

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/problem+json" \
 -H "Content-Type: application/json" \
 "https://localhost/topology-inventory/v1/groups/{groupId}/provided-members-operations" \
 -d '{
  "providedMembers" : [ "{}", "{}" ],
  "operation" : "merge"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GroupsApi;

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

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

        // Create an instance of the API class
        GroupsApi apiInstance = new GroupsApi();
        String accept = application/json; // String | 
        String contentType = application/json; // String | 
        String groupId = groupId_example; // String | 
        UpdateProvidedMembersPayload updateProvidedMembersPayload = ; // UpdateProvidedMembersPayload | 

        try {
            apiInstance.updateProvidedMembers(accept, contentType, groupId, updateProvidedMembersPayload);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#updateProvidedMembers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String accept = new String(); // String | 
final String contentType = new String(); // String | 
final String groupId = new String(); // String | 
final UpdateProvidedMembersPayload updateProvidedMembersPayload = new UpdateProvidedMembersPayload(); // UpdateProvidedMembersPayload | 

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

import org.openapitools.client.api.GroupsApi;

public class GroupsApiExample {
    public static void main(String[] args) {
        GroupsApi apiInstance = new GroupsApi();
        String accept = application/json; // String | 
        String contentType = application/json; // String | 
        String groupId = groupId_example; // String | 
        UpdateProvidedMembersPayload updateProvidedMembersPayload = ; // UpdateProvidedMembersPayload | 

        try {
            apiInstance.updateProvidedMembers(accept, contentType, groupId, updateProvidedMembersPayload);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#updateProvidedMembers");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GroupsApi *apiInstance = [[GroupsApi alloc] init];
String *accept = application/json; //  (default to application/json)
String *contentType = application/json; //  (default to application/json)
String *groupId = groupId_example; //  (default to null)
UpdateProvidedMembersPayload *updateProvidedMembersPayload = ; // 

// Merge or remove members of a static group.
[apiInstance updateProvidedMembersWith:accept
    contentType:contentType
    groupId:groupId
    updateProvidedMembersPayload:updateProvidedMembersPayload
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');

// Create an instance of the API class
var api = new TopologyExposureAndInventoryApi.GroupsApi()
var accept = application/json; // {String} 
var contentType = application/json; // {String} 
var groupId = groupId_example; // {String} 
var updateProvidedMembersPayload = ; // {UpdateProvidedMembersPayload} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateProvidedMembers(accept, contentType, groupId, updateProvidedMembersPayload, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new GroupsApi();
            var accept = application/json;  // String |  (default to application/json)
            var contentType = application/json;  // String |  (default to application/json)
            var groupId = groupId_example;  // String |  (default to null)
            var updateProvidedMembersPayload = new UpdateProvidedMembersPayload(); // UpdateProvidedMembersPayload | 

            try {
                // Merge or remove members of a static group.
                apiInstance.updateProvidedMembers(accept, contentType, groupId, updateProvidedMembersPayload);
            } catch (Exception e) {
                Debug.Print("Exception when calling GroupsApi.updateProvidedMembers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GroupsApi();
$accept = application/json; // String | 
$contentType = application/json; // String | 
$groupId = groupId_example; // String | 
$updateProvidedMembersPayload = ; // UpdateProvidedMembersPayload | 

try {
    $api_instance->updateProvidedMembers($accept, $contentType, $groupId, $updateProvidedMembersPayload);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->updateProvidedMembers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GroupsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GroupsApi->new();
my $accept = application/json; # String | 
my $contentType = application/json; # String | 
my $groupId = groupId_example; # String | 
my $updateProvidedMembersPayload = WWW::OPenAPIClient::Object::UpdateProvidedMembersPayload->new(); # UpdateProvidedMembersPayload | 

eval {
    $api_instance->updateProvidedMembers(accept => $accept, contentType => $contentType, groupId => $groupId, updateProvidedMembersPayload => $updateProvidedMembersPayload);
};
if ($@) {
    warn "Exception when calling GroupsApi->updateProvidedMembers: $@\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.GroupsApi()
accept = application/json # String |  (default to application/json)
contentType = application/json # String |  (default to application/json)
groupId = groupId_example # String |  (default to null)
updateProvidedMembersPayload =  # UpdateProvidedMembersPayload | 

try:
    # Merge or remove members of a static group.
    api_instance.update_provided_members(accept, contentType, groupId, updateProvidedMembersPayload)
except ApiException as e:
    print("Exception when calling GroupsApi->updateProvidedMembers: %s\n" % e)
extern crate GroupsApi;

pub fn main() {
    let accept = application/json; // String
    let contentType = application/json; // String
    let groupId = groupId_example; // String
    let updateProvidedMembersPayload = ; // UpdateProvidedMembersPayload

    let mut context = GroupsApi::Context::default();
    let result = client.updateProvidedMembers(accept, contentType, groupId, updateProvidedMembersPayload, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
groupId*
String
Required
Header parameters
Name Description
Accept*
String
Required
Content-Type*
String
Required
Body parameters
Name Description
updateProvidedMembersPayload *

Responses


Schemas

createSchema

Create a new schema.

Create a new schema. The request body contains the schema in YANG format.


/schemas

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/problem+json" \
 -H "Content-Type: multipart/form-data" \
 "https://localhost/topology-inventory/v1/schemas"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SchemasApi;

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

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

        // Create an instance of the API class
        SchemasApi apiInstance = new SchemasApi();
        String accept = application/json; // String | 
        String contentType = multipart/form-data; // String | 
        File file = BINARY_DATA_HERE; // File | multipartFile

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

final api_instance = DefaultApi();

final String accept = new String(); // String | 
final String contentType = new String(); // String | 
final File file = new File(); // File | multipartFile

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

import org.openapitools.client.api.SchemasApi;

public class SchemasApiExample {
    public static void main(String[] args) {
        SchemasApi apiInstance = new SchemasApi();
        String accept = application/json; // String | 
        String contentType = multipart/form-data; // String | 
        File file = BINARY_DATA_HERE; // File | multipartFile

        try {
            apiInstance.createSchema(accept, contentType, file);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchemasApi#createSchema");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SchemasApi *apiInstance = [[SchemasApi alloc] init];
String *accept = application/json; //  (default to application/json)
String *contentType = multipart/form-data; //  (default to multipart/form-data)
File *file = BINARY_DATA_HERE; // multipartFile (default to null)

// Create a new schema.
[apiInstance createSchemaWith:accept
    contentType:contentType
    file:file
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');

// Create an instance of the API class
var api = new TopologyExposureAndInventoryApi.SchemasApi()
var accept = application/json; // {String} 
var contentType = multipart/form-data; // {String} 
var file = BINARY_DATA_HERE; // {File} multipartFile

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

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

            // Create an instance of the API class
            var apiInstance = new SchemasApi();
            var accept = application/json;  // String |  (default to application/json)
            var contentType = multipart/form-data;  // String |  (default to multipart/form-data)
            var file = BINARY_DATA_HERE;  // File | multipartFile (default to null)

            try {
                // Create a new schema.
                apiInstance.createSchema(accept, contentType, file);
            } catch (Exception e) {
                Debug.Print("Exception when calling SchemasApi.createSchema: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SchemasApi();
$accept = application/json; // String | 
$contentType = multipart/form-data; // String | 
$file = BINARY_DATA_HERE; // File | multipartFile

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SchemasApi->new();
my $accept = application/json; # String | 
my $contentType = multipart/form-data; # String | 
my $file = BINARY_DATA_HERE; # File | multipartFile

eval {
    $api_instance->createSchema(accept => $accept, contentType => $contentType, file => $file);
};
if ($@) {
    warn "Exception when calling SchemasApi->createSchema: $@\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.SchemasApi()
accept = application/json # String |  (default to application/json)
contentType = multipart/form-data # String |  (default to multipart/form-data)
file = BINARY_DATA_HERE # File | multipartFile (default to null)

try:
    # Create a new schema.
    api_instance.create_schema(accept, contentType, file)
except ApiException as e:
    print("Exception when calling SchemasApi->createSchema: %s\n" % e)
extern crate SchemasApi;

pub fn main() {
    let accept = application/json; // String
    let contentType = multipart/form-data; // String
    let file = BINARY_DATA_HERE; // File

    let mut context = SchemasApi::Context::default();
    let result = client.createSchema(accept, contentType, file, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
Accept*
String
Required
Content-Type*
String
Required
Form parameters
Name Description
file*
File (binary)
multipartFile
Required

Responses


deleteSchema

Delete a schema.

Delete a schema.


/schemas/{schemaName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/problem+json" \
 "https://localhost/topology-inventory/v1/schemas/{schemaName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SchemasApi;

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

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

        // Create an instance of the API class
        SchemasApi apiInstance = new SchemasApi();
        String accept = application/json; // String | 
        String schemaName = schemaName_example; // String | 

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

final api_instance = DefaultApi();

final String accept = new String(); // String | 
final String schemaName = new String(); // String | 

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

import org.openapitools.client.api.SchemasApi;

public class SchemasApiExample {
    public static void main(String[] args) {
        SchemasApi apiInstance = new SchemasApi();
        String accept = application/json; // String | 
        String schemaName = schemaName_example; // String | 

        try {
            apiInstance.deleteSchema(accept, schemaName);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchemasApi#deleteSchema");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SchemasApi *apiInstance = [[SchemasApi alloc] init];
String *accept = application/json; //  (default to application/json)
String *schemaName = schemaName_example; //  (default to o-ran-smo-teiv-ran)

// Delete a schema.
[apiInstance deleteSchemaWith:accept
    schemaName:schemaName
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');

// Create an instance of the API class
var api = new TopologyExposureAndInventoryApi.SchemasApi()
var accept = application/json; // {String} 
var schemaName = schemaName_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new SchemasApi();
            var accept = application/json;  // String |  (default to application/json)
            var schemaName = schemaName_example;  // String |  (default to o-ran-smo-teiv-ran)

            try {
                // Delete a schema.
                apiInstance.deleteSchema(accept, schemaName);
            } catch (Exception e) {
                Debug.Print("Exception when calling SchemasApi.deleteSchema: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SchemasApi();
$accept = application/json; // String | 
$schemaName = schemaName_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SchemasApi->new();
my $accept = application/json; # String | 
my $schemaName = schemaName_example; # String | 

eval {
    $api_instance->deleteSchema(accept => $accept, schemaName => $schemaName);
};
if ($@) {
    warn "Exception when calling SchemasApi->deleteSchema: $@\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.SchemasApi()
accept = application/json # String |  (default to application/json)
schemaName = schemaName_example # String |  (default to o-ran-smo-teiv-ran)

try:
    # Delete a schema.
    api_instance.delete_schema(accept, schemaName)
except ApiException as e:
    print("Exception when calling SchemasApi->deleteSchema: %s\n" % e)
extern crate SchemasApi;

pub fn main() {
    let accept = application/json; // String
    let schemaName = schemaName_example; // String

    let mut context = SchemasApi::Context::default();
    let result = client.deleteSchema(accept, schemaName, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
schemaName*
String
Required
Header parameters
Name Description
Accept*
String
Required

Responses


getSchemaByName

Get the model schema.

Get the model schema by name.


/schemas/{schemaName}/content

Usage and SDK Samples

curl -X GET \
 -H "Accept: text/plain,application/problem+json" \
 "https://localhost/topology-inventory/v1/schemas/{schemaName}/content"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SchemasApi;

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

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

        // Create an instance of the API class
        SchemasApi apiInstance = new SchemasApi();
        String accept = accept_example; // String | 
        String schemaName = schemaName_example; // String | 

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

final api_instance = DefaultApi();

final String accept = new String(); // String | 
final String schemaName = new String(); // String | 

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

import org.openapitools.client.api.SchemasApi;

public class SchemasApiExample {
    public static void main(String[] args) {
        SchemasApi apiInstance = new SchemasApi();
        String accept = accept_example; // String | 
        String schemaName = schemaName_example; // String | 

        try {
            'String' result = apiInstance.getSchemaByName(accept, schemaName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchemasApi#getSchemaByName");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SchemasApi *apiInstance = [[SchemasApi alloc] init];
String *accept = accept_example; //  (default to text/plain)
String *schemaName = schemaName_example; //  (default to o-ran-smo-teiv-ran)

// Get the model schema.
[apiInstance getSchemaByNameWith:accept
    schemaName:schemaName
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');

// Create an instance of the API class
var api = new TopologyExposureAndInventoryApi.SchemasApi()
var accept = accept_example; // {String} 
var schemaName = schemaName_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new SchemasApi();
            var accept = accept_example;  // String |  (default to text/plain)
            var schemaName = schemaName_example;  // String |  (default to o-ran-smo-teiv-ran)

            try {
                // Get the model schema.
                'String' result = apiInstance.getSchemaByName(accept, schemaName);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SchemasApi.getSchemaByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SchemasApi();
$accept = accept_example; // String | 
$schemaName = schemaName_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SchemasApi->new();
my $accept = accept_example; # String | 
my $schemaName = schemaName_example; # String | 

eval {
    my $result = $api_instance->getSchemaByName(accept => $accept, schemaName => $schemaName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SchemasApi->getSchemaByName: $@\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.SchemasApi()
accept = accept_example # String |  (default to text/plain)
schemaName = schemaName_example # String |  (default to o-ran-smo-teiv-ran)

try:
    # Get the model schema.
    api_response = api_instance.get_schema_by_name(accept, schemaName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SchemasApi->getSchemaByName: %s\n" % e)
extern crate SchemasApi;

pub fn main() {
    let accept = accept_example; // String
    let schemaName = schemaName_example; // String

    let mut context = SchemasApi::Context::default();
    let result = client.getSchemaByName(accept, schemaName, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
schemaName*
String
Required
Header parameters
Name Description
Accept*
String
Required

Responses


getSchemas

Get a list of all pre defined schemas.

Get a list of all topology model schemas.


/schemas

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://localhost/topology-inventory/v1/schemas?domain=RAN&offset=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SchemasApi;

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

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

        // Create an instance of the API class
        SchemasApi apiInstance = new SchemasApi();
        String accept = application/json; // String | 
        String domain = RAN; // String | 
        Integer offset = 56; // Integer | Pagination offset.
        Integer limit = 56; // Integer | Result limiter.

        try {
            Schemas result = apiInstance.getSchemas(accept, domain, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchemasApi#getSchemas");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String accept = new String(); // String | 
final String domain = new String(); // String | 
final Integer offset = new Integer(); // Integer | Pagination offset.
final Integer limit = new Integer(); // Integer | Result limiter.

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

import org.openapitools.client.api.SchemasApi;

public class SchemasApiExample {
    public static void main(String[] args) {
        SchemasApi apiInstance = new SchemasApi();
        String accept = application/json; // String | 
        String domain = RAN; // String | 
        Integer offset = 56; // Integer | Pagination offset.
        Integer limit = 56; // Integer | Result limiter.

        try {
            Schemas result = apiInstance.getSchemas(accept, domain, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchemasApi#getSchemas");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SchemasApi *apiInstance = [[SchemasApi alloc] init];
String *accept = application/json; //  (default to application/json)
String *domain = RAN; //  (optional) (default to null)
Integer *offset = 56; // Pagination offset. (optional) (default to 0)
Integer *limit = 56; // Result limiter. (optional) (default to 500)

// Get a list of all pre defined schemas.
[apiInstance getSchemasWith:accept
    domain:domain
    offset:offset
    limit:limit
              completionHandler: ^(Schemas output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');

// Create an instance of the API class
var api = new TopologyExposureAndInventoryApi.SchemasApi()
var accept = application/json; // {String} 
var opts = {
  'domain': RAN, // {String} 
  'offset': 56, // {Integer} Pagination offset.
  'limit': 56 // {Integer} Result limiter.
};

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

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

            // Create an instance of the API class
            var apiInstance = new SchemasApi();
            var accept = application/json;  // String |  (default to application/json)
            var domain = RAN;  // String |  (optional)  (default to null)
            var offset = 56;  // Integer | Pagination offset. (optional)  (default to 0)
            var limit = 56;  // Integer | Result limiter. (optional)  (default to 500)

            try {
                // Get a list of all pre defined schemas.
                Schemas result = apiInstance.getSchemas(accept, domain, offset, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SchemasApi.getSchemas: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SchemasApi();
$accept = application/json; // String | 
$domain = RAN; // String | 
$offset = 56; // Integer | Pagination offset.
$limit = 56; // Integer | Result limiter.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SchemasApi->new();
my $accept = application/json; # String | 
my $domain = RAN; # String | 
my $offset = 56; # Integer | Pagination offset.
my $limit = 56; # Integer | Result limiter.

eval {
    my $result = $api_instance->getSchemas(accept => $accept, domain => $domain, offset => $offset, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SchemasApi->getSchemas: $@\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.SchemasApi()
accept = application/json # String |  (default to application/json)
domain = RAN # String |  (optional) (default to null)
offset = 56 # Integer | Pagination offset. (optional) (default to 0)
limit = 56 # Integer | Result limiter. (optional) (default to 500)

try:
    # Get a list of all pre defined schemas.
    api_response = api_instance.get_schemas(accept, domain=domain, offset=offset, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SchemasApi->getSchemas: %s\n" % e)
extern crate SchemasApi;

pub fn main() {
    let accept = application/json; // String
    let domain = RAN; // String
    let offset = 56; // Integer
    let limit = 56; // Integer

    let mut context = SchemasApi::Context::default();
    let result = client.getSchemas(accept, domain, offset, limit, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
Accept*
String
Required
Query parameters
Name Description
domain
String
offset
Integer
Pagination offset.
limit
Integer
Result limiter.

Responses


UserDefinedSchemas

createUserDefinedSchema

Create a new user defined schema.

Create a new user defined schema. The request body contains the schema in YANG format.


/user-defined-schemas

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json,application/problem+json" \
 -H "Content-Type: multipart/form-data" \
 "https://localhost/topology-inventory/v1/user-defined-schemas"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserDefinedSchemasApi;

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

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

        // Create an instance of the API class
        UserDefinedSchemasApi apiInstance = new UserDefinedSchemasApi();
        String accept = application/json; // String | 
        String contentType = multipart/form-data; // String | 
        File file = BINARY_DATA_HERE; // File | multipartFile

        try {
            UserDefinedSchema result = apiInstance.createUserDefinedSchema(accept, contentType, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserDefinedSchemasApi#createUserDefinedSchema");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String accept = new String(); // String | 
final String contentType = new String(); // String | 
final File file = new File(); // File | multipartFile

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

import org.openapitools.client.api.UserDefinedSchemasApi;

public class UserDefinedSchemasApiExample {
    public static void main(String[] args) {
        UserDefinedSchemasApi apiInstance = new UserDefinedSchemasApi();
        String accept = application/json; // String | 
        String contentType = multipart/form-data; // String | 
        File file = BINARY_DATA_HERE; // File | multipartFile

        try {
            UserDefinedSchema result = apiInstance.createUserDefinedSchema(accept, contentType, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserDefinedSchemasApi#createUserDefinedSchema");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserDefinedSchemasApi *apiInstance = [[UserDefinedSchemasApi alloc] init];
String *accept = application/json; //  (default to application/json)
String *contentType = multipart/form-data; //  (default to multipart/form-data)
File *file = BINARY_DATA_HERE; // multipartFile (default to null)

// Create a new user defined schema.
[apiInstance createUserDefinedSchemaWith:accept
    contentType:contentType
    file:file
              completionHandler: ^(UserDefinedSchema output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');

// Create an instance of the API class
var api = new TopologyExposureAndInventoryApi.UserDefinedSchemasApi()
var accept = application/json; // {String} 
var contentType = multipart/form-data; // {String} 
var file = BINARY_DATA_HERE; // {File} multipartFile

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

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

            // Create an instance of the API class
            var apiInstance = new UserDefinedSchemasApi();
            var accept = application/json;  // String |  (default to application/json)
            var contentType = multipart/form-data;  // String |  (default to multipart/form-data)
            var file = BINARY_DATA_HERE;  // File | multipartFile (default to null)

            try {
                // Create a new user defined schema.
                UserDefinedSchema result = apiInstance.createUserDefinedSchema(accept, contentType, file);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserDefinedSchemasApi.createUserDefinedSchema: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserDefinedSchemasApi();
$accept = application/json; // String | 
$contentType = multipart/form-data; // String | 
$file = BINARY_DATA_HERE; // File | multipartFile

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserDefinedSchemasApi->new();
my $accept = application/json; # String | 
my $contentType = multipart/form-data; # String | 
my $file = BINARY_DATA_HERE; # File | multipartFile

eval {
    my $result = $api_instance->createUserDefinedSchema(accept => $accept, contentType => $contentType, file => $file);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserDefinedSchemasApi->createUserDefinedSchema: $@\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.UserDefinedSchemasApi()
accept = application/json # String |  (default to application/json)
contentType = multipart/form-data # String |  (default to multipart/form-data)
file = BINARY_DATA_HERE # File | multipartFile (default to null)

try:
    # Create a new user defined schema.
    api_response = api_instance.create_user_defined_schema(accept, contentType, file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserDefinedSchemasApi->createUserDefinedSchema: %s\n" % e)
extern crate UserDefinedSchemasApi;

pub fn main() {
    let accept = application/json; // String
    let contentType = multipart/form-data; // String
    let file = BINARY_DATA_HERE; // File

    let mut context = UserDefinedSchemasApi::Context::default();
    let result = client.createUserDefinedSchema(accept, contentType, file, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
Accept*
String
Required
Content-Type*
String
Required
Form parameters
Name Description
file*
File (binary)
multipartFile
Required

Responses

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


deleteUserDefinedSchema

Delete a user defined schema.

Delete a user defined schema.


/user-defined-schemas/{schemaName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/problem+json" \
 "https://localhost/topology-inventory/v1/user-defined-schemas/{schemaName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserDefinedSchemasApi;

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

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

        // Create an instance of the API class
        UserDefinedSchemasApi apiInstance = new UserDefinedSchemasApi();
        String accept = application/json; // String | 
        String schemaName = schemaName_example; // String | 

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

final api_instance = DefaultApi();

final String accept = new String(); // String | 
final String schemaName = new String(); // String | 

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

import org.openapitools.client.api.UserDefinedSchemasApi;

public class UserDefinedSchemasApiExample {
    public static void main(String[] args) {
        UserDefinedSchemasApi apiInstance = new UserDefinedSchemasApi();
        String accept = application/json; // String | 
        String schemaName = schemaName_example; // String | 

        try {
            apiInstance.deleteUserDefinedSchema(accept, schemaName);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserDefinedSchemasApi#deleteUserDefinedSchema");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserDefinedSchemasApi *apiInstance = [[UserDefinedSchemasApi alloc] init];
String *accept = application/json; //  (default to application/json)
String *schemaName = schemaName_example; //  (default to o-ran-smo-teiv-ran)

// Delete a user defined schema.
[apiInstance deleteUserDefinedSchemaWith:accept
    schemaName:schemaName
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');

// Create an instance of the API class
var api = new TopologyExposureAndInventoryApi.UserDefinedSchemasApi()
var accept = application/json; // {String} 
var schemaName = schemaName_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new UserDefinedSchemasApi();
            var accept = application/json;  // String |  (default to application/json)
            var schemaName = schemaName_example;  // String |  (default to o-ran-smo-teiv-ran)

            try {
                // Delete a user defined schema.
                apiInstance.deleteUserDefinedSchema(accept, schemaName);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserDefinedSchemasApi.deleteUserDefinedSchema: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserDefinedSchemasApi();
$accept = application/json; // String | 
$schemaName = schemaName_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserDefinedSchemasApi->new();
my $accept = application/json; # String | 
my $schemaName = schemaName_example; # String | 

eval {
    $api_instance->deleteUserDefinedSchema(accept => $accept, schemaName => $schemaName);
};
if ($@) {
    warn "Exception when calling UserDefinedSchemasApi->deleteUserDefinedSchema: $@\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.UserDefinedSchemasApi()
accept = application/json # String |  (default to application/json)
schemaName = schemaName_example # String |  (default to o-ran-smo-teiv-ran)

try:
    # Delete a user defined schema.
    api_instance.delete_user_defined_schema(accept, schemaName)
except ApiException as e:
    print("Exception when calling UserDefinedSchemasApi->deleteUserDefinedSchema: %s\n" % e)
extern crate UserDefinedSchemasApi;

pub fn main() {
    let accept = application/json; // String
    let schemaName = schemaName_example; // String

    let mut context = UserDefinedSchemasApi::Context::default();
    let result = client.deleteUserDefinedSchema(accept, schemaName, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
schemaName*
String
Required
Header parameters
Name Description
Accept*
String
Required

Responses


getUserDefinedSchemaByName

Get the user defined model schema.

Get the user defined model schema by name.


/user-defined-schemas/{schemaName}/content

Usage and SDK Samples

curl -X GET \
 -H "Accept: text/plain,application/problem+json" \
 "https://localhost/topology-inventory/v1/user-defined-schemas/{schemaName}/content"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserDefinedSchemasApi;

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

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

        // Create an instance of the API class
        UserDefinedSchemasApi apiInstance = new UserDefinedSchemasApi();
        String accept = accept_example; // String | 
        String schemaName = schemaName_example; // String | 

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

final api_instance = DefaultApi();

final String accept = new String(); // String | 
final String schemaName = new String(); // String | 

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

import org.openapitools.client.api.UserDefinedSchemasApi;

public class UserDefinedSchemasApiExample {
    public static void main(String[] args) {
        UserDefinedSchemasApi apiInstance = new UserDefinedSchemasApi();
        String accept = accept_example; // String | 
        String schemaName = schemaName_example; // String | 

        try {
            'String' result = apiInstance.getUserDefinedSchemaByName(accept, schemaName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserDefinedSchemasApi#getUserDefinedSchemaByName");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserDefinedSchemasApi *apiInstance = [[UserDefinedSchemasApi alloc] init];
String *accept = accept_example; //  (default to text/plain)
String *schemaName = schemaName_example; //  (default to o-ran-smo-teiv-ran)

// Get the user defined model schema.
[apiInstance getUserDefinedSchemaByNameWith:accept
    schemaName:schemaName
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');

// Create an instance of the API class
var api = new TopologyExposureAndInventoryApi.UserDefinedSchemasApi()
var accept = accept_example; // {String} 
var schemaName = schemaName_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new UserDefinedSchemasApi();
            var accept = accept_example;  // String |  (default to text/plain)
            var schemaName = schemaName_example;  // String |  (default to o-ran-smo-teiv-ran)

            try {
                // Get the user defined model schema.
                'String' result = apiInstance.getUserDefinedSchemaByName(accept, schemaName);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserDefinedSchemasApi.getUserDefinedSchemaByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserDefinedSchemasApi();
$accept = accept_example; // String | 
$schemaName = schemaName_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserDefinedSchemasApi->new();
my $accept = accept_example; # String | 
my $schemaName = schemaName_example; # String | 

eval {
    my $result = $api_instance->getUserDefinedSchemaByName(accept => $accept, schemaName => $schemaName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserDefinedSchemasApi->getUserDefinedSchemaByName: $@\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.UserDefinedSchemasApi()
accept = accept_example # String |  (default to text/plain)
schemaName = schemaName_example # String |  (default to o-ran-smo-teiv-ran)

try:
    # Get the user defined model schema.
    api_response = api_instance.get_user_defined_schema_by_name(accept, schemaName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserDefinedSchemasApi->getUserDefinedSchemaByName: %s\n" % e)
extern crate UserDefinedSchemasApi;

pub fn main() {
    let accept = accept_example; // String
    let schemaName = schemaName_example; // String

    let mut context = UserDefinedSchemasApi::Context::default();
    let result = client.getUserDefinedSchemaByName(accept, schemaName, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
schemaName*
String
Required
Header parameters
Name Description
Accept*
String
Required

Responses


getUserDefinedSchemas

Get a list of all used defined schemas.

Get a list of all user defined schemas.


/user-defined-schemas

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://localhost/topology-inventory/v1/user-defined-schemas?offset=56&limit=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserDefinedSchemasApi;

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

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

        // Create an instance of the API class
        UserDefinedSchemasApi apiInstance = new UserDefinedSchemasApi();
        String accept = application/json; // String | 
        Integer offset = 56; // Integer | Pagination offset.
        Integer limit = 56; // Integer | Result limiter.

        try {
            UserDefinedSchemas result = apiInstance.getUserDefinedSchemas(accept, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserDefinedSchemasApi#getUserDefinedSchemas");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String accept = new String(); // String | 
final Integer offset = new Integer(); // Integer | Pagination offset.
final Integer limit = new Integer(); // Integer | Result limiter.

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

import org.openapitools.client.api.UserDefinedSchemasApi;

public class UserDefinedSchemasApiExample {
    public static void main(String[] args) {
        UserDefinedSchemasApi apiInstance = new UserDefinedSchemasApi();
        String accept = application/json; // String | 
        Integer offset = 56; // Integer | Pagination offset.
        Integer limit = 56; // Integer | Result limiter.

        try {
            UserDefinedSchemas result = apiInstance.getUserDefinedSchemas(accept, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserDefinedSchemasApi#getUserDefinedSchemas");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UserDefinedSchemasApi *apiInstance = [[UserDefinedSchemasApi alloc] init];
String *accept = application/json; //  (default to application/json)
Integer *offset = 56; // Pagination offset. (optional) (default to 0)
Integer *limit = 56; // Result limiter. (optional) (default to 500)

// Get a list of all used defined schemas.
[apiInstance getUserDefinedSchemasWith:accept
    offset:offset
    limit:limit
              completionHandler: ^(UserDefinedSchemas output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');

// Create an instance of the API class
var api = new TopologyExposureAndInventoryApi.UserDefinedSchemasApi()
var accept = application/json; // {String} 
var opts = {
  'offset': 56, // {Integer} Pagination offset.
  'limit': 56 // {Integer} Result limiter.
};

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

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

            // Create an instance of the API class
            var apiInstance = new UserDefinedSchemasApi();
            var accept = application/json;  // String |  (default to application/json)
            var offset = 56;  // Integer | Pagination offset. (optional)  (default to 0)
            var limit = 56;  // Integer | Result limiter. (optional)  (default to 500)

            try {
                // Get a list of all used defined schemas.
                UserDefinedSchemas result = apiInstance.getUserDefinedSchemas(accept, offset, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserDefinedSchemasApi.getUserDefinedSchemas: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserDefinedSchemasApi();
$accept = application/json; // String | 
$offset = 56; // Integer | Pagination offset.
$limit = 56; // Integer | Result limiter.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserDefinedSchemasApi->new();
my $accept = application/json; # String | 
my $offset = 56; # Integer | Pagination offset.
my $limit = 56; # Integer | Result limiter.

eval {
    my $result = $api_instance->getUserDefinedSchemas(accept => $accept, offset => $offset, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserDefinedSchemasApi->getUserDefinedSchemas: $@\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.UserDefinedSchemasApi()
accept = application/json # String |  (default to application/json)
offset = 56 # Integer | Pagination offset. (optional) (default to 0)
limit = 56 # Integer | Result limiter. (optional) (default to 500)

try:
    # Get a list of all used defined schemas.
    api_response = api_instance.get_user_defined_schemas(accept, offset=offset, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserDefinedSchemasApi->getUserDefinedSchemas: %s\n" % e)
extern crate UserDefinedSchemasApi;

pub fn main() {
    let accept = application/json; // String
    let offset = 56; // Integer
    let limit = 56; // Integer

    let mut context = UserDefinedSchemasApi::Context::default();
    let result = client.getUserDefinedSchemas(accept, offset, limit, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
Accept*
String
Required
Query parameters
Name Description
offset
Integer
Pagination offset.
limit
Integer
Result limiter.

Responses