Topology and Inventory API

Classifiers

updateClassifier

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

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


/classifiers

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/problem+json" \
 -H "Content-Type: application/json" \
 "https://localhost/topology-inventory/v1alpha11/classifiers" \
 -d '{
  "classifier" : [ "classifier", "classifier" ],
  "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 TopologyAndInventoryApi = require('topology_and_inventory_api');

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


Collections

createCollection

Create a collection.

Create a collection.


/collections

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json,application/problem+json" \
 -H "Content-Type: application/json" \
 "https://localhost/topology-inventory/v1alpha11/collections" \
 -d '{
  "criteria" : {
    "resourceInstances" : [ "resourceInstances", "resourceInstances" ]
  },
  "collectionName" : "collectionName"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

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

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

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        String accept = application/json; // String | 
        String contentType = application/json; // String | 
        Collection collection = ; // Collection | 

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

final api_instance = DefaultApi();

final String accept = new String(); // String | 
final String contentType = new String(); // String | 
final Collection collection = new Collection(); // Collection | 

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

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        String accept = application/json; // String | 
        String contentType = application/json; // String | 
        Collection collection = ; // Collection | 

        try {
            CollectionResponse result = apiInstance.createCollection(accept, contentType, collection);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#createCollection");
            e.printStackTrace();
        }
    }
}


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

// Create a collection.
[apiInstance createCollectionWith:accept
    contentType:contentType
    collection:collection
              completionHandler: ^(CollectionResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyAndInventoryApi = require('topology_and_inventory_api');

// Create an instance of the API class
var api = new TopologyAndInventoryApi.CollectionsApi()
var accept = application/json; // {String} 
var contentType = application/json; // {String} 
var collection = ; // {Collection} 

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

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

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var accept = application/json;  // String |  (default to application/json)
            var contentType = application/json;  // String |  (default to application/json)
            var collection = new Collection(); // Collection | 

            try {
                // Create a collection.
                CollectionResponse result = apiInstance.createCollection(accept, contentType, collection);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.createCollection: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

try:
    # Create a collection.
    api_response = api_instance.create_collection(accept, contentType, collection)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectionsApi->createCollection: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let accept = application/json; // String
    let contentType = application/json; // String
    let collection = ; // Collection

    let mut context = CollectionsApi::Context::default();
    let result = client.createCollection(accept, contentType, collection, &context).wait();

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

Scopes

Parameters

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

Responses


deleteCollection

Delete a collection with specified id.

Delete a collection with specified id.


/collections/{collectionId}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/problem+json" \
 "https://localhost/topology-inventory/v1alpha11/collections/{collectionId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

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

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

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        String accept = application/json; // String | 
        String collectionId = collectionId_example; // String | 

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        String accept = application/json; // String | 
        String collectionId = collectionId_example; // String | 

        try {
            apiInstance.deleteCollection(accept, collectionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#deleteCollection");
            e.printStackTrace();
        }
    }
}


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

// Delete a collection with specified id.
[apiInstance deleteCollectionWith:accept
    collectionId:collectionId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyAndInventoryApi = require('topology_and_inventory_api');

// Create an instance of the API class
var api = new TopologyAndInventoryApi.CollectionsApi()
var accept = application/json; // {String} 
var collectionId = collectionId_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var accept = application/json;  // String |  (default to application/json)
            var collectionId = collectionId_example;  // String |  (default to null)

            try {
                // Delete a collection with specified id.
                apiInstance.deleteCollection(accept, collectionId);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.deleteCollection: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

eval {
    $api_instance->deleteCollection(accept => $accept, collectionId => $collectionId);
};
if ($@) {
    warn "Exception when calling CollectionsApi->deleteCollection: $@\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.CollectionsApi()
accept = application/json # String |  (default to application/json)
collectionId = collectionId_example # String |  (default to null)

try:
    # Delete a collection with specified id.
    api_instance.delete_collection(accept, collectionId)
except ApiException as e:
    print("Exception when calling CollectionsApi->deleteCollection: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let accept = application/json; // String
    let collectionId = collectionId_example; // String

    let mut context = CollectionsApi::Context::default();
    let result = client.deleteCollection(accept, collectionId, &context).wait();

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

Scopes

Parameters

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

Responses


getAllCollections

Get all collections.

Get all collections.


/collections

Usage and SDK Samples

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

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

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

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

        try {
            Collections result = apiInstance.getAllCollections(accept, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#getAllCollections");
            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.getAllCollections(accept, offset, limit);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getAllCollections: $e\n');
}

import org.openapitools.client.api.CollectionsApi;

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

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


// Create an instance of the API class
CollectionsApi *apiInstance = [[CollectionsApi 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 collections.
[apiInstance getAllCollectionsWith:accept
    offset:offset
    limit:limit
              completionHandler: ^(Collections output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyAndInventoryApi = require('topology_and_inventory_api');

// Create an instance of the API class
var api = new TopologyAndInventoryApi.CollectionsApi()
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.getAllCollections(accept, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            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 collections.
                Collections result = apiInstance.getAllCollections(accept, offset, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.getAllCollections: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

eval {
    my $result = $api_instance->getAllCollections(accept => $accept, offset => $offset, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectionsApi->getAllCollections: $@\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.CollectionsApi()
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 collections.
    api_response = api_instance.get_all_collections(accept, offset=offset, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectionsApi->getAllCollections: %s\n" % e)
extern crate CollectionsApi;

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

    let mut context = CollectionsApi::Context::default();
    let result = client.getAllCollections(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


getCollection

Get a collection with specified id.

Get a collection with specified id.


/collections/{collectionId}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://localhost/topology-inventory/v1alpha11/collections/{collectionId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

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

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

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        String accept = application/json; // String | 
        String collectionId = collectionId_example; // String | 

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        String accept = application/json; // String | 
        String collectionId = collectionId_example; // String | 

        try {
            CollectionResponse result = apiInstance.getCollection(accept, collectionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#getCollection");
            e.printStackTrace();
        }
    }
}


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

// Get a collection with specified id.
[apiInstance getCollectionWith:accept
    collectionId:collectionId
              completionHandler: ^(CollectionResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyAndInventoryApi = require('topology_and_inventory_api');

// Create an instance of the API class
var api = new TopologyAndInventoryApi.CollectionsApi()
var accept = application/json; // {String} 
var collectionId = collectionId_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var accept = application/json;  // String |  (default to application/json)
            var collectionId = collectionId_example;  // String |  (default to null)

            try {
                // Get a collection with specified id.
                CollectionResponse result = apiInstance.getCollection(accept, collectionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.getCollection: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

try:
    # Get a collection with specified id.
    api_response = api_instance.get_collection(accept, collectionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CollectionsApi->getCollection: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let accept = application/json; // String
    let collectionId = collectionId_example; // String

    let mut context = CollectionsApi::Context::default();
    let result = client.getCollection(accept, collectionId, &context).wait();

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

Scopes

Parameters

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

Responses


updateCollection

Update a collection.

Update a collection.


/collections/{collectionId}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/problem+json" \
 -H "Content-Type: application/json" \
 "https://localhost/topology-inventory/v1alpha11/collections/{collectionId}" \
 -d '{
  "criteria" : {
    "resourceInstances" : [ "resourceInstances", "resourceInstances" ]
  },
  "collectionName" : "collectionName"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CollectionsApi;

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

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

        // Create an instance of the API class
        CollectionsApi apiInstance = new CollectionsApi();
        String accept = application/json; // String | 
        String contentType = application/json; // String | 
        String collectionId = collectionId_example; // String | 
        Collection collection = ; // Collection | 

        try {
            apiInstance.updateCollection(accept, contentType, collectionId, collection);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#updateCollection");
            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 collectionId = new String(); // String | 
final Collection collection = new Collection(); // Collection | 

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

import org.openapitools.client.api.CollectionsApi;

public class CollectionsApiExample {
    public static void main(String[] args) {
        CollectionsApi apiInstance = new CollectionsApi();
        String accept = application/json; // String | 
        String contentType = application/json; // String | 
        String collectionId = collectionId_example; // String | 
        Collection collection = ; // Collection | 

        try {
            apiInstance.updateCollection(accept, contentType, collectionId, collection);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectionsApi#updateCollection");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
String *accept = application/json; //  (default to application/json)
String *contentType = application/json; //  (default to application/json)
String *collectionId = collectionId_example; //  (default to null)
Collection *collection = ; // 

// Update a collection.
[apiInstance updateCollectionWith:accept
    contentType:contentType
    collectionId:collectionId
    collection:collection
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyAndInventoryApi = require('topology_and_inventory_api');

// Create an instance of the API class
var api = new TopologyAndInventoryApi.CollectionsApi()
var accept = application/json; // {String} 
var contentType = application/json; // {String} 
var collectionId = collectionId_example; // {String} 
var collection = ; // {Collection} 

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

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

            // Create an instance of the API class
            var apiInstance = new CollectionsApi();
            var accept = application/json;  // String |  (default to application/json)
            var contentType = application/json;  // String |  (default to application/json)
            var collectionId = collectionId_example;  // String |  (default to null)
            var collection = new Collection(); // Collection | 

            try {
                // Update a collection.
                apiInstance.updateCollection(accept, contentType, collectionId, collection);
            } catch (Exception e) {
                Debug.Print("Exception when calling CollectionsApi.updateCollection: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
$accept = application/json; // String | 
$contentType = application/json; // String | 
$collectionId = collectionId_example; // String | 
$collection = ; // Collection | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
my $accept = application/json; # String | 
my $contentType = application/json; # String | 
my $collectionId = collectionId_example; # String | 
my $collection = WWW::OPenAPIClient::Object::Collection->new(); # Collection | 

eval {
    $api_instance->updateCollection(accept => $accept, contentType => $contentType, collectionId => $collectionId, collection => $collection);
};
if ($@) {
    warn "Exception when calling CollectionsApi->updateCollection: $@\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.CollectionsApi()
accept = application/json # String |  (default to application/json)
contentType = application/json # String |  (default to application/json)
collectionId = collectionId_example # String |  (default to null)
collection =  # Collection | 

try:
    # Update a collection.
    api_instance.update_collection(accept, contentType, collectionId, collection)
except ApiException as e:
    print("Exception when calling CollectionsApi->updateCollection: %s\n" % e)
extern crate CollectionsApi;

pub fn main() {
    let accept = application/json; // String
    let contentType = application/json; // String
    let collectionId = collectionId_example; // String
    let collection = ; // Collection

    let mut context = CollectionsApi::Context::default();
    let result = client.updateCollection(accept, contentType, collectionId, collection, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
collectionId*
String
Required
Header parameters
Name Description
Accept*
String
Required
Content-Type*
String
Required
Body parameters
Name Description
collection *

Responses


Decorators

updateDecorator

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

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


/decorators

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/problem+json" \
 -H "Content-Type: application/json" \
 "https://localhost/topology-inventory/v1alpha11/decorators" \
 -d '{
  "decorators" : {
    "key" : "decorators"
  },
  "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 TopologyAndInventoryApi = require('topology_and_inventory_api');

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


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/v1alpha11/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 TopologyAndInventoryApi = require('topology_and_inventory_api');

// Create an instance of the API class
var api = new TopologyAndInventoryApi.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 entity type name with specified id. Specified id represents the entity instance.

Get all relationships for entity type name with specified id. Specified id represents the entity instance.


/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/v1alpha11/domains/{domainName}/entity-types/{entityTypeName}/entities/{entityId}/relationships?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 = domainName_example; // String | domain name
        String entityTypeName = entityTypeName_example; // String | 
        String entityId = entityId_example; // String | 
        Integer offset = 56; // Integer | Pagination offset.
        Integer limit = 56; // Integer | Result limiter.

        try {
            RelationshipsResponseMessage result = apiInstance.getAllRelationshipsForEntityId(accept, domainName, entityTypeName, entityId, 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 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, 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 = domainName_example; // String | domain name
        String entityTypeName = entityTypeName_example; // String | 
        String entityId = entityId_example; // String | 
        Integer offset = 56; // Integer | Pagination offset.
        Integer limit = 56; // Integer | Result limiter.

        try {
            RelationshipsResponseMessage result = apiInstance.getAllRelationshipsForEntityId(accept, domainName, entityTypeName, entityId, 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 = domainName_example; // domain name (default to null)
String *entityTypeName = entityTypeName_example; //  (default to null)
String *entityId = entityId_example; //  (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 entity type name with specified id. Specified id represents the entity instance.
[apiInstance getAllRelationshipsForEntityIdWith:accept
    domainName:domainName
    entityTypeName:entityTypeName
    entityId:entityId
    offset:offset
    limit:limit
              completionHandler: ^(RelationshipsResponseMessage output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyAndInventoryApi = require('topology_and_inventory_api');

// Create an instance of the API class
var api = new TopologyAndInventoryApi.EntitiesAndRelationshipsApi()
var accept = application/json; // {String} 
var domainName = domainName_example; // {String} domain name
var entityTypeName = entityTypeName_example; // {String} 
var entityId = entityId_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.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 = domainName_example;  // String | domain name (default to null)
            var entityTypeName = entityTypeName_example;  // String |  (default to null)
            var entityId = entityId_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 all relationships for entity type name with specified id. Specified id represents the entity instance.
                RelationshipsResponseMessage result = apiInstance.getAllRelationshipsForEntityId(accept, domainName, entityTypeName, entityId, 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 = domainName_example; // String | domain name
$entityTypeName = entityTypeName_example; // String | 
$entityId = entityId_example; // String | 
$offset = 56; // Integer | Pagination offset.
$limit = 56; // Integer | Result limiter.

try {
    $result = $api_instance->getAllRelationshipsForEntityId($accept, $domainName, $entityTypeName, $entityId, $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 = domainName_example; # String | domain name
my $entityTypeName = entityTypeName_example; # String | 
my $entityId = entityId_example; # String | 
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, 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 = domainName_example # String | domain name (default to null)
entityTypeName = entityTypeName_example # String |  (default to null)
entityId = entityId_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 all relationships for entity type name with specified id. Specified id represents the entity instance.
    api_response = api_instance.get_all_relationships_for_entity_id(accept, domainName, entityTypeName, entityId, 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 = domainName_example; // String
    let entityTypeName = entityTypeName_example; // String
    let entityId = entityId_example; // String
    let offset = 56; // Integer
    let limit = 56; // Integer

    let mut context = EntitiesAndRelationshipsApi::Context::default();
    let result = client.getAllRelationshipsForEntityId(accept, domainName, entityTypeName, entityId, 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
offset
Integer
Pagination offset.
limit
Integer
Result limiter.

Responses


getEntitiesByDomain

Get entities by domain

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


/domains/{domainName}/entities

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://localhost/topology-inventory/v1alpha11/domains/{domainName}/entities?targetFilter=/attributes(nCI,nRPCI)&scopeFilter=/attributes[@nRTAC=310"]&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 = domainName_example; // String | domain name
        String targetFilter = /attributes(nCI,nRPCI); // String | Use *targetFilter* to specify the entity type and attributes to be returned in the REST response. The value for *targetFilter* can also be a list of entity types and attributes.
        String scopeFilter = /attributes[@nRTAC=310"]; // String | Use *scopeFilter* to specify the attributes to match on. The value for *scopeFilter* can also be a list of entity types and attributes. scopeFilter returns a boolean.
        Integer offset = 56; // Integer | Pagination offset.
        Integer limit = 56; // Integer | Result limiter.

        try {
            EntitiesResponseMessage 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 the entity type and attributes to be returned in the REST response. The value for *targetFilter* can also be a list of entity types and attributes.
final String scopeFilter = new String(); // String | Use *scopeFilter* to specify the attributes to match on. The value for *scopeFilter* can also be a list of entity types and attributes. scopeFilter returns a boolean.
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 = domainName_example; // String | domain name
        String targetFilter = /attributes(nCI,nRPCI); // String | Use *targetFilter* to specify the entity type and attributes to be returned in the REST response. The value for *targetFilter* can also be a list of entity types and attributes.
        String scopeFilter = /attributes[@nRTAC=310"]; // String | Use *scopeFilter* to specify the attributes to match on. The value for *scopeFilter* can also be a list of entity types and attributes. scopeFilter returns a boolean.
        Integer offset = 56; // Integer | Pagination offset.
        Integer limit = 56; // Integer | Result limiter.

        try {
            EntitiesResponseMessage 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 = domainName_example; // domain name (default to null)
String *targetFilter = /attributes(nCI,nRPCI); // Use *targetFilter* to specify the entity type and attributes to be returned in the REST response. The value for *targetFilter* can also be a list of entity types and attributes. (optional) (default to null)
String *scopeFilter = /attributes[@nRTAC=310"]; // Use *scopeFilter* to specify the attributes to match on. The value for *scopeFilter* can also be a list of entity types and attributes. scopeFilter returns a boolean. (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: ^(EntitiesResponseMessage output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyAndInventoryApi = require('topology_and_inventory_api');

// Create an instance of the API class
var api = new TopologyAndInventoryApi.EntitiesAndRelationshipsApi()
var accept = application/json; // {String} 
var domainName = domainName_example; // {String} domain name
var opts = {
  'targetFilter': /attributes(nCI,nRPCI), // {String} Use *targetFilter* to specify the entity type and attributes to be returned in the REST response. The value for *targetFilter* can also be a list of entity types and attributes.
  'scopeFilter': /attributes[@nRTAC=310"], // {String} Use *scopeFilter* to specify the attributes to match on. The value for *scopeFilter* can also be a list of entity types and attributes. scopeFilter returns a boolean.
  '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 = domainName_example;  // String | domain name (default to null)
            var targetFilter = /attributes(nCI,nRPCI);  // String | Use *targetFilter* to specify the entity type and attributes to be returned in the REST response. The value for *targetFilter* can also be a list of entity types and attributes. (optional)  (default to null)
            var scopeFilter = /attributes[@nRTAC=310"];  // String | Use *scopeFilter* to specify the attributes to match on. The value for *scopeFilter* can also be a list of entity types and attributes. scopeFilter returns a boolean. (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
                EntitiesResponseMessage 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 = domainName_example; // String | domain name
$targetFilter = /attributes(nCI,nRPCI); // String | Use *targetFilter* to specify the entity type and attributes to be returned in the REST response. The value for *targetFilter* can also be a list of entity types and attributes.
$scopeFilter = /attributes[@nRTAC=310"]; // String | Use *scopeFilter* to specify the attributes to match on. The value for *scopeFilter* can also be a list of entity types and attributes. scopeFilter returns a boolean.
$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 = domainName_example; # String | domain name
my $targetFilter = /attributes(nCI,nRPCI); # String | Use *targetFilter* to specify the entity type and attributes to be returned in the REST response. The value for *targetFilter* can also be a list of entity types and attributes.
my $scopeFilter = /attributes[@nRTAC=310"]; # String | Use *scopeFilter* to specify the attributes to match on. The value for *scopeFilter* can also be a list of entity types and attributes. scopeFilter returns a boolean.
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 = domainName_example # String | domain name (default to null)
targetFilter = /attributes(nCI,nRPCI) # String | Use *targetFilter* to specify the entity type and attributes to be returned in the REST response. The value for *targetFilter* can also be a list of entity types and attributes. (optional) (default to null)
scopeFilter = /attributes[@nRTAC=310"] # String | Use *scopeFilter* to specify the attributes to match on. The value for *scopeFilter* can also be a list of entity types and attributes. scopeFilter returns a boolean. (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 = domainName_example; // String
    let targetFilter = /attributes(nCI,nRPCI); // String
    let scopeFilter = /attributes[@nRTAC=310"]; // 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 the entity type and attributes to be returned in the REST response. The value for *targetFilter* can also be a list of entity types and attributes.
scopeFilter
String
Use *scopeFilter* to specify the attributes to match on. The value for *scopeFilter* can also be a list of entity types and attributes. scopeFilter returns a boolean.
offset
Integer
Pagination offset.
limit
Integer
Result limiter.

Responses


getRelationshipById

Get relationship with specified id. Specified id represents the relationship instance.

Get relationship with specified id. Specified id represents the relationship instance.


/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/v1alpha11/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/json; // String | 
        String domainName = domainName_example; // 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/json; // String | 
        String domainName = domainName_example; // 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/json; //  (default to application/json)
String *domainName = domainName_example; // domain name (default to null)
String *relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; //  (default to null)
String *relationshipId = relationshipId_example; //  (default to null)

// Get relationship with specified id. Specified id represents the relationship instance.
[apiInstance getRelationshipByIdWith:accept
    domainName:domainName
    relationshipTypeName:relationshipTypeName
    relationshipId:relationshipId
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyAndInventoryApi = require('topology_and_inventory_api');

// Create an instance of the API class
var api = new TopologyAndInventoryApi.EntitiesAndRelationshipsApi()
var accept = application/json; // {String} 
var domainName = domainName_example; // {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/json;  // String |  (default to application/json)
            var domainName = domainName_example;  // 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 relationship with specified id. Specified id represents the relationship instance.
                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/json; // String | 
$domainName = domainName_example; // 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/json; # String | 
my $domainName = domainName_example; # 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/json # String |  (default to application/json)
domainName = domainName_example # String | domain name (default to null)
relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER # String |  (default to null)
relationshipId = relationshipId_example # String |  (default to null)

try:
    # Get relationship with specified id. Specified id represents the relationship instance.
    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/json; // String
    let domainName = domainName_example; // 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 topology relationships of a specific relationship type name.

Get topology relationships of a specific relationship type 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/v1alpha11/domains/{domainName}/relationship-types/{relationshipTypeName}/relationships?targetFilter=/attributes(nCI,nRPCI)&scopeFilter=/attributes[@nRTAC=310"]&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 = domainName_example; // String | domain name
        String relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String | 
        String targetFilter = /attributes(nCI,nRPCI); // String | Use *targetFilter* to specify the entity type and attributes to be returned in the REST response. The value for *targetFilter* can also be a list of entity types and attributes.
        String scopeFilter = /attributes[@nRTAC=310"]; // String | Use *scopeFilter* to specify the attributes to match on. The value for *scopeFilter* can also be a list of entity types and attributes. scopeFilter returns a boolean.
        Integer offset = 56; // Integer | Pagination offset.
        Integer limit = 56; // Integer | Result limiter.

        try {
            RelationshipsResponseMessage 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 the entity type and attributes to be returned in the REST response. The value for *targetFilter* can also be a list of entity types and attributes.
final String scopeFilter = new String(); // String | Use *scopeFilter* to specify the attributes to match on. The value for *scopeFilter* can also be a list of entity types and attributes. scopeFilter returns a boolean.
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 = domainName_example; // String | domain name
        String relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String | 
        String targetFilter = /attributes(nCI,nRPCI); // String | Use *targetFilter* to specify the entity type and attributes to be returned in the REST response. The value for *targetFilter* can also be a list of entity types and attributes.
        String scopeFilter = /attributes[@nRTAC=310"]; // String | Use *scopeFilter* to specify the attributes to match on. The value for *scopeFilter* can also be a list of entity types and attributes. scopeFilter returns a boolean.
        Integer offset = 56; // Integer | Pagination offset.
        Integer limit = 56; // Integer | Result limiter.

        try {
            RelationshipsResponseMessage 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 = domainName_example; // domain name (default to null)
String *relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; //  (default to null)
String *targetFilter = /attributes(nCI,nRPCI); // Use *targetFilter* to specify the entity type and attributes to be returned in the REST response. The value for *targetFilter* can also be a list of entity types and attributes. (optional) (default to null)
String *scopeFilter = /attributes[@nRTAC=310"]; // Use *scopeFilter* to specify the attributes to match on. The value for *scopeFilter* can also be a list of entity types and attributes. scopeFilter returns a boolean. (optional) (default to null)
Integer *offset = 56; // Pagination offset. (optional) (default to 0)
Integer *limit = 56; // Result limiter. (optional) (default to 500)

// Get topology relationships of a specific relationship type name.
[apiInstance getRelationshipsByTypeWith:accept
    domainName:domainName
    relationshipTypeName:relationshipTypeName
    targetFilter:targetFilter
    scopeFilter:scopeFilter
    offset:offset
    limit:limit
              completionHandler: ^(RelationshipsResponseMessage output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyAndInventoryApi = require('topology_and_inventory_api');

// Create an instance of the API class
var api = new TopologyAndInventoryApi.EntitiesAndRelationshipsApi()
var accept = application/json; // {String} 
var domainName = domainName_example; // {String} domain name
var relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // {String} 
var opts = {
  'targetFilter': /attributes(nCI,nRPCI), // {String} Use *targetFilter* to specify the entity type and attributes to be returned in the REST response. The value for *targetFilter* can also be a list of entity types and attributes.
  'scopeFilter': /attributes[@nRTAC=310"], // {String} Use *scopeFilter* to specify the attributes to match on. The value for *scopeFilter* can also be a list of entity types and attributes. scopeFilter returns a boolean.
  '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 = domainName_example;  // String | domain name (default to null)
            var relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER;  // String |  (default to null)
            var targetFilter = /attributes(nCI,nRPCI);  // String | Use *targetFilter* to specify the entity type and attributes to be returned in the REST response. The value for *targetFilter* can also be a list of entity types and attributes. (optional)  (default to null)
            var scopeFilter = /attributes[@nRTAC=310"];  // String | Use *scopeFilter* to specify the attributes to match on. The value for *scopeFilter* can also be a list of entity types and attributes. scopeFilter returns a boolean. (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 topology relationships of a specific relationship type name.
                RelationshipsResponseMessage 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 = domainName_example; // String | domain name
$relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String | 
$targetFilter = /attributes(nCI,nRPCI); // String | Use *targetFilter* to specify the entity type and attributes to be returned in the REST response. The value for *targetFilter* can also be a list of entity types and attributes.
$scopeFilter = /attributes[@nRTAC=310"]; // String | Use *scopeFilter* to specify the attributes to match on. The value for *scopeFilter* can also be a list of entity types and attributes. scopeFilter returns a boolean.
$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 = domainName_example; # String | domain name
my $relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; # String | 
my $targetFilter = /attributes(nCI,nRPCI); # String | Use *targetFilter* to specify the entity type and attributes to be returned in the REST response. The value for *targetFilter* can also be a list of entity types and attributes.
my $scopeFilter = /attributes[@nRTAC=310"]; # String | Use *scopeFilter* to specify the attributes to match on. The value for *scopeFilter* can also be a list of entity types and attributes. scopeFilter returns a boolean.
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 = domainName_example # String | domain name (default to null)
relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER # String |  (default to null)
targetFilter = /attributes(nCI,nRPCI) # String | Use *targetFilter* to specify the entity type and attributes to be returned in the REST response. The value for *targetFilter* can also be a list of entity types and attributes. (optional) (default to null)
scopeFilter = /attributes[@nRTAC=310"] # String | Use *scopeFilter* to specify the attributes to match on. The value for *scopeFilter* can also be a list of entity types and attributes. scopeFilter returns a boolean. (optional) (default to null)
offset = 56 # Integer | Pagination offset. (optional) (default to 0)
limit = 56 # Integer | Result limiter. (optional) (default to 500)

try:
    # Get 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 = domainName_example; // String
    let relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String
    let targetFilter = /attributes(nCI,nRPCI); // String
    let scopeFilter = /attributes[@nRTAC=310"]; // 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 the entity type and attributes to be returned in the REST response. The value for *targetFilter* can also be a list of entity types and attributes.
scopeFilter
String
Use *scopeFilter* to specify the attributes to match on. The value for *scopeFilter* can also be a list of entity types and attributes. scopeFilter returns a boolean.
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/v1alpha11/domains/{domainName}/entity-types/{entityTypeName}/entities?targetFilter=/attributes(nCI,nRPCI)&scopeFilter=/attributes[@nRTAC=310"]&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 = domainName_example; // String | domain name
        String entityTypeName = entityTypeName_example; // String | 
        String targetFilter = /attributes(nCI,nRPCI); // String | Use *targetFilter* to specify the entity type and attributes to be returned in the REST response. The value for *targetFilter* can also be a list of entity types and attributes.
        String scopeFilter = /attributes[@nRTAC=310"]; // String | Use *scopeFilter* to specify the attributes to match on. The value for *scopeFilter* can also be a list of entity types and attributes. scopeFilter returns a boolean.
        Integer offset = 56; // Integer | Pagination offset.
        Integer limit = 56; // Integer | Result limiter.

        try {
            EntitiesResponseMessage 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 the entity type and attributes to be returned in the REST response. The value for *targetFilter* can also be a list of entity types and attributes.
final String scopeFilter = new String(); // String | Use *scopeFilter* to specify the attributes to match on. The value for *scopeFilter* can also be a list of entity types and attributes. scopeFilter returns a boolean.
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 = domainName_example; // String | domain name
        String entityTypeName = entityTypeName_example; // String | 
        String targetFilter = /attributes(nCI,nRPCI); // String | Use *targetFilter* to specify the entity type and attributes to be returned in the REST response. The value for *targetFilter* can also be a list of entity types and attributes.
        String scopeFilter = /attributes[@nRTAC=310"]; // String | Use *scopeFilter* to specify the attributes to match on. The value for *scopeFilter* can also be a list of entity types and attributes. scopeFilter returns a boolean.
        Integer offset = 56; // Integer | Pagination offset.
        Integer limit = 56; // Integer | Result limiter.

        try {
            EntitiesResponseMessage 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 = domainName_example; // domain name (default to null)
String *entityTypeName = entityTypeName_example; //  (default to null)
String *targetFilter = /attributes(nCI,nRPCI); // Use *targetFilter* to specify the entity type and attributes to be returned in the REST response. The value for *targetFilter* can also be a list of entity types and attributes. (optional) (default to null)
String *scopeFilter = /attributes[@nRTAC=310"]; // Use *scopeFilter* to specify the attributes to match on. The value for *scopeFilter* can also be a list of entity types and attributes. scopeFilter returns a boolean. (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: ^(EntitiesResponseMessage output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyAndInventoryApi = require('topology_and_inventory_api');

// Create an instance of the API class
var api = new TopologyAndInventoryApi.EntitiesAndRelationshipsApi()
var accept = application/json; // {String} 
var domainName = domainName_example; // {String} domain name
var entityTypeName = entityTypeName_example; // {String} 
var opts = {
  'targetFilter': /attributes(nCI,nRPCI), // {String} Use *targetFilter* to specify the entity type and attributes to be returned in the REST response. The value for *targetFilter* can also be a list of entity types and attributes.
  'scopeFilter': /attributes[@nRTAC=310"], // {String} Use *scopeFilter* to specify the attributes to match on. The value for *scopeFilter* can also be a list of entity types and attributes. scopeFilter returns a boolean.
  '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 = domainName_example;  // String | domain name (default to null)
            var entityTypeName = entityTypeName_example;  // String |  (default to null)
            var targetFilter = /attributes(nCI,nRPCI);  // String | Use *targetFilter* to specify the entity type and attributes to be returned in the REST response. The value for *targetFilter* can also be a list of entity types and attributes. (optional)  (default to null)
            var scopeFilter = /attributes[@nRTAC=310"];  // String | Use *scopeFilter* to specify the attributes to match on. The value for *scopeFilter* can also be a list of entity types and attributes. scopeFilter returns a boolean. (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.
                EntitiesResponseMessage 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 = domainName_example; // String | domain name
$entityTypeName = entityTypeName_example; // String | 
$targetFilter = /attributes(nCI,nRPCI); // String | Use *targetFilter* to specify the entity type and attributes to be returned in the REST response. The value for *targetFilter* can also be a list of entity types and attributes.
$scopeFilter = /attributes[@nRTAC=310"]; // String | Use *scopeFilter* to specify the attributes to match on. The value for *scopeFilter* can also be a list of entity types and attributes. scopeFilter returns a boolean.
$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 = domainName_example; # String | domain name
my $entityTypeName = entityTypeName_example; # String | 
my $targetFilter = /attributes(nCI,nRPCI); # String | Use *targetFilter* to specify the entity type and attributes to be returned in the REST response. The value for *targetFilter* can also be a list of entity types and attributes.
my $scopeFilter = /attributes[@nRTAC=310"]; # String | Use *scopeFilter* to specify the attributes to match on. The value for *scopeFilter* can also be a list of entity types and attributes. scopeFilter returns a boolean.
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 = domainName_example # String | domain name (default to null)
entityTypeName = entityTypeName_example # String |  (default to null)
targetFilter = /attributes(nCI,nRPCI) # String | Use *targetFilter* to specify the entity type and attributes to be returned in the REST response. The value for *targetFilter* can also be a list of entity types and attributes. (optional) (default to null)
scopeFilter = /attributes[@nRTAC=310"] # String | Use *scopeFilter* to specify the attributes to match on. The value for *scopeFilter* can also be a list of entity types and attributes. scopeFilter returns a boolean. (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 = domainName_example; // String
    let entityTypeName = entityTypeName_example; // String
    let targetFilter = /attributes(nCI,nRPCI); // String
    let scopeFilter = /attributes[@nRTAC=310"]; // 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 the entity type and attributes to be returned in the REST response. The value for *targetFilter* can also be a list of entity types and attributes.
scopeFilter
String
Use *scopeFilter* to specify the attributes to match on. The value for *scopeFilter* can also be a list of entity types and attributes. scopeFilter returns a boolean.
offset
Integer
Pagination offset.
limit
Integer
Result limiter.

Responses


getTopologyById

Get topology for entity type name with specified id. Specified id represents the entity instance.

Get topology for entity type name with specified id. Specified id represents the entity instance.


/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/v1alpha11/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/json; // String | 
        String domainName = domainName_example; // 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/json; // String | 
        String domainName = domainName_example; // 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/json; //  (default to application/json)
String *domainName = domainName_example; // domain name (default to null)
String *entityTypeName = entityTypeName_example; //  (default to null)
String *entityId = entityId_example; //  (default to null)

// Get topology for entity type name with specified id. Specified id represents the entity instance.
[apiInstance getTopologyByIdWith:accept
    domainName:domainName
    entityTypeName:entityTypeName
    entityId:entityId
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyAndInventoryApi = require('topology_and_inventory_api');

// Create an instance of the API class
var api = new TopologyAndInventoryApi.EntitiesAndRelationshipsApi()
var accept = application/json; // {String} 
var domainName = domainName_example; // {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/json;  // String |  (default to application/json)
            var domainName = domainName_example;  // String | domain name (default to null)
            var entityTypeName = entityTypeName_example;  // String |  (default to null)
            var entityId = entityId_example;  // String |  (default to null)

            try {
                // Get topology for entity type name with specified id. Specified id represents the entity instance.
                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/json; // String | 
$domainName = domainName_example; // 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/json; # String | 
my $domainName = domainName_example; # 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/json # String |  (default to application/json)
domainName = domainName_example # String | domain name (default to null)
entityTypeName = entityTypeName_example # String |  (default to null)
entityId = entityId_example # String |  (default to null)

try:
    # Get topology for entity type name with specified id. Specified id represents the entity instance.
    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/json; // String
    let domainName = domainName_example; // 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/v1alpha11/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 = domainName_example; // 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 = domainName_example; // 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 = domainName_example; // 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 TopologyAndInventoryApi = require('topology_and_inventory_api');

// Create an instance of the API class
var api = new TopologyAndInventoryApi.EntitiesAndRelationshipsApi()
var accept = application/json; // {String} 
var domainName = domainName_example; // {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 = domainName_example;  // 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 = domainName_example; // 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 = domainName_example; # 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 = domainName_example # 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 = domainName_example; // 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/v1alpha11/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 = domainName_example; // 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 = domainName_example; // 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 = domainName_example; // 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 TopologyAndInventoryApi = require('topology_and_inventory_api');

// Create an instance of the API class
var api = new TopologyAndInventoryApi.EntitiesAndRelationshipsApi()
var accept = application/json; // {String} 
var domainName = domainName_example; // {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 = domainName_example;  // 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 = domainName_example; // 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 = domainName_example; # 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 = domainName_example # 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 = domainName_example; // 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


GeoQuery

geoQueryTopologyAcrossDomains

Geo query topology entity or entities across topology domains.

Geo query topology entity or entities across topology domains.


/geo-queries

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json,application/problem+json" \
 -H "Content-Type: application/json" \
 "https://localhost/topology-inventory/v1alpha11/geo-queries?offset=56&limit=56" \
 -d '{
  "query" : "query"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GeoQueryApi;

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

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

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

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

final api_instance = DefaultApi();

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

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

import org.openapitools.client.api.GeoQueryApi;

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

        try {
            Object result = apiInstance.geoQueryTopologyAcrossDomains(accept, contentType, queryMessage, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GeoQueryApi#geoQueryTopologyAcrossDomains");
            e.printStackTrace();
        }
    }
}


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

// Geo query topology entity or entities  across topology domains.
[apiInstance geoQueryTopologyAcrossDomainsWith:accept
    contentType:contentType
    queryMessage:queryMessage
    offset:offset
    limit:limit
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyAndInventoryApi = require('topology_and_inventory_api');

// Create an instance of the API class
var api = new TopologyAndInventoryApi.GeoQueryApi()
var accept = application/json; // {String} 
var contentType = application/json; // {String} 
var queryMessage = ; // {QueryMessage} 
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.geoQueryTopologyAcrossDomains(accept, contentType, queryMessage, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

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

            try {
                // Geo query topology entity or entities  across topology domains.
                Object result = apiInstance.geoQueryTopologyAcrossDomains(accept, contentType, queryMessage, offset, limit);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GeoQueryApi.geoQueryTopologyAcrossDomains: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

try:
    # Geo query topology entity or entities  across topology domains.
    api_response = api_instance.geo_query_topology_across_domains(accept, contentType, queryMessage, offset=offset, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GeoQueryApi->geoQueryTopologyAcrossDomains: %s\n" % e)
extern crate GeoQueryApi;

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

    let mut context = GeoQueryApi::Context::default();
    let result = client.geoQueryTopologyAcrossDomains(accept, contentType, queryMessage, offset, limit, &context).wait();

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

Scopes

Parameters

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

Query parameters
Name Description
offset
Integer
Pagination offset.
limit
Integer
Result limiter.

Responses


Schemas

createSchema

Create a new schema.

Create a new schema.


/schemas

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/problem+json" \
 -H "Content-Type: multipart/form-data" \
 "https://localhost/topology-inventory/v1alpha11/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 = application/json; // 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 = application/json; // 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 = application/json; //  (default to application/json)
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 TopologyAndInventoryApi = require('topology_and_inventory_api');

// Create an instance of the API class
var api = new TopologyAndInventoryApi.SchemasApi()
var accept = application/json; // {String} 
var contentType = application/json; // {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 = application/json;  // String |  (default to application/json)
            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 = application/json; // 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 = application/json; # 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 = application/json # String |  (default to application/json)
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 = application/json; // 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/v1alpha11/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 TopologyAndInventoryApi = require('topology_and_inventory_api');

// Create an instance of the API class
var api = new TopologyAndInventoryApi.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/v1alpha11/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 = application/json; // 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 = application/json; // 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 = application/json; //  (default to application/json)
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 TopologyAndInventoryApi = require('topology_and_inventory_api');

// Create an instance of the API class
var api = new TopologyAndInventoryApi.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. 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 = application/json;  // String |  (default to application/json)
            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 = application/json; // 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 = application/json; # 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 = application/json # String |  (default to application/json)
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 = application/json; // 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 schemas.

Get a list of all schemas.


/schemas

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://localhost/topology-inventory/v1alpha11/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 {
            SchemaList 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 {
            SchemaList 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 schemas.
[apiInstance getSchemasWith:accept
    domain:domain
    offset:offset
    limit:limit
              completionHandler: ^(SchemaList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var TopologyAndInventoryApi = require('topology_and_inventory_api');

// Create an instance of the API class
var api = new TopologyAndInventoryApi.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 schemas.
                SchemaList 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 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