Decorators
+createCollection
-Create a collection.
+updateDecorator
+Update entities and/or relationships with decorator(s).
Create a collection.
+Update entities and/or relationships with decorator(s). The sum of the given entityIds and relationshipIds cannot exceed 100 by default.
-
/collections
+ /decorators
Usage and SDK Samples
-
-
- Curl -
- Java -
- Dart -
- Android - -
- Obj-C -
- JavaScript - -
- C# -
- PHP -
- Perl -
- Python -
- Rust +
- Curl +
- Java +
- Dart +
- Android + +
- Obj-C +
- JavaScript + +
- C# +
- PHP +
- Perl +
- Python +
- Rust
curl -X POST \
- -H "Accept: application/json,application/problem+json" \
+ -H "Accept: application/problem+json" \
-H "Content-Type: application/json" \
- "https://localhost/topology-inventory/v1alpha11/collections" \
+ "https://localhost/topology-inventory/v1alpha11/decorators" \
-d '{
- "criteria" : {
- "resourceInstances" : [ "resourceInstances", "resourceInstances" ]
+ "decorators" : {
+ "key" : ""
},
- "collectionName" : "collectionName"
+ "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.CollectionsApi;
+import org.openapitools.client.api.DecoratorsApi;
import java.io.File;
import java.util.*;
-public class CollectionsApiExample {
+public class DecoratorsApiExample {
public static void main(String[] args) {
// Create an instance of the API class
- CollectionsApi apiInstance = new CollectionsApi();
+ DecoratorsApi apiInstance = new DecoratorsApi();
String accept = application/json; // String |
String contentType = application/json; // String |
- Collection collection = ; // Collection |
+ Decorator decorator = ; // Decorator |
try {
- CollectionResponse result = apiInstance.createCollection(accept, contentType, collection);
- System.out.println(result);
+ apiInstance.updateDecorator(accept, contentType, decorator);
} catch (ApiException e) {
- System.err.println("Exception when calling CollectionsApi#createCollection");
+ System.err.println("Exception when calling DecoratorsApi#updateDecorator");
e.printStackTrace();
}
}
@@ -2347,66 +2391,62 @@ public class CollectionsApiExample {
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 |
+final Decorator decorator = new Decorator(); // Decorator |
try {
- final result = await api_instance.createCollection(accept, contentType, collection);
+ final result = await api_instance.updateDecorator(accept, contentType, decorator);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->createCollection: $e\n');
+ print('Exception when calling DefaultApi->updateDecorator: $e\n');
}
import org.openapitools.client.api.CollectionsApi;
+
+ import org.openapitools.client.api.DecoratorsApi;
-public class CollectionsApiExample {
+public class DecoratorsApiExample {
public static void main(String[] args) {
- CollectionsApi apiInstance = new CollectionsApi();
+ DecoratorsApi apiInstance = new DecoratorsApi();
String accept = application/json; // String |
String contentType = application/json; // String |
- Collection collection = ; // Collection |
+ Decorator decorator = ; // Decorator |
try {
- CollectionResponse result = apiInstance.createCollection(accept, contentType, collection);
- System.out.println(result);
+ apiInstance.updateDecorator(accept, contentType, decorator);
} catch (ApiException e) {
- System.err.println("Exception when calling CollectionsApi#createCollection");
+ System.err.println("Exception when calling DecoratorsApi#updateDecorator");
e.printStackTrace();
}
}
}
-
+
// Create an instance of the API class
-CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
+DecoratorsApi *apiInstance = [[DecoratorsApi alloc] init];
String *accept = application/json; // (default to application/json)
String *contentType = application/json; // (default to application/json)
-Collection *collection = ; //
+Decorator *decorator = ; //
-// Create a collection.
-[apiInstance createCollectionWith:accept
+// Update entities and/or relationships with decorator(s).
+[apiInstance updateDecoratorWith:accept
contentType:contentType
- collection:collection
- completionHandler: ^(CollectionResponse output, NSError* error) {
- if (output) {
- NSLog(@"%@", output);
- }
+ decorator:decorator
+ completionHandler: ^(NSError* error) {
if (error) {
NSLog(@"Error: %@", error);
}
@@ -2414,30 +2454,30 @@ Collection *collection = ; //
-
- var TopologyAndInventoryApi = require('topology_and_inventory_api');
+
+ var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
-var api = new TopologyAndInventoryApi.CollectionsApi()
+var api = new TopologyExposureAndInventoryApi.DecoratorsApi()
var accept = application/json; // {String}
var contentType = application/json; // {String}
-var collection = ; // {Collection}
+var decorator = ; // {Decorator}
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
- console.log('API called successfully. Returned data: ' + data);
+ console.log('API called successfully.');
}
};
-api.createCollection(accept, contentType, collection, callback);
+api.updateDecorator(accept, contentType, decorator, callback);
-
-
+
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
@@ -2446,23 +2486,22 @@ using Org.OpenAPITools.Model;
namespace Example
{
- public class createCollectionExample
+ public class updateDecoratorExample
{
public void main()
{
// Create an instance of the API class
- var apiInstance = new CollectionsApi();
+ var apiInstance = new DecoratorsApi();
var accept = application/json; // String | (default to application/json)
var contentType = application/json; // String | (default to application/json)
- var collection = new Collection(); // Collection |
+ var decorator = new Decorator(); // Decorator |
try {
- // Create a collection.
- CollectionResponse result = apiInstance.createCollection(accept, contentType, collection);
- Debug.WriteLine(result);
+ // Update entities and/or relationships with decorator(s).
+ apiInstance.updateDecorator(accept, contentType, decorator);
} catch (Exception e) {
- Debug.Print("Exception when calling CollectionsApi.createCollection: " + e.Message );
+ Debug.Print("Exception when calling DecoratorsApi.updateDecorator: " + e.Message );
}
}
}
@@ -2470,46 +2509,44 @@ namespace Example
-
+
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Create an instance of the API class
-$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
+$api_instance = new OpenAPITools\Client\Api\DecoratorsApi();
$accept = application/json; // String |
$contentType = application/json; // String |
-$collection = ; // Collection |
+$decorator = ; // Decorator |
try {
- $result = $api_instance->createCollection($accept, $contentType, $collection);
- print_r($result);
+ $api_instance->updateDecorator($accept, $contentType, $decorator);
} catch (Exception $e) {
- echo 'Exception when calling CollectionsApi->createCollection: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling DecoratorsApi->updateDecorator: ', $e->getMessage(), PHP_EOL;
}
?>
-
+
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::CollectionsApi;
+use WWW::OPenAPIClient::DecoratorsApi;
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
+my $api_instance = WWW::OPenAPIClient::DecoratorsApi->new();
my $accept = application/json; # String |
my $contentType = application/json; # String |
-my $collection = WWW::OPenAPIClient::Object::Collection->new(); # Collection |
+my $decorator = WWW::OPenAPIClient::Object::Decorator->new(); # Decorator |
eval {
- my $result = $api_instance->createCollection(accept => $accept, contentType => $contentType, collection => $collection);
- print Dumper($result);
+ $api_instance->updateDecorator(accept => $accept, contentType => $contentType, decorator => $decorator);
};
if ($@) {
- warn "Exception when calling CollectionsApi->createCollection: $@\n";
+ warn "Exception when calling DecoratorsApi->updateDecorator: $@\n";
}
-
+
from __future__ import print_statement
import time
import openapi_client
@@ -2517,29 +2554,28 @@ from openapi_client.rest import ApiException
from pprint import pprint
# Create an instance of the API class
-api_instance = openapi_client.CollectionsApi()
+api_instance = openapi_client.DecoratorsApi()
accept = application/json # String | (default to application/json)
contentType = application/json # String | (default to application/json)
-collection = # Collection |
+decorator = # Decorator |
try:
- # Create a collection.
- api_response = api_instance.create_collection(accept, contentType, collection)
- pprint(api_response)
+ # Update entities and/or relationships with decorator(s).
+ api_instance.update_decorator(accept, contentType, decorator)
except ApiException as e:
- print("Exception when calling CollectionsApi->createCollection: %s\n" % e)
+ print("Exception when calling DecoratorsApi->updateDecorator: %s\n" % e)
-
- extern crate CollectionsApi;
+
+ extern crate DecoratorsApi;
pub fn main() {
let accept = application/json; // String
let contentType = application/json; // String
- let collection = ; // Collection
+ let decorator = ; // Decorator
- let mut context = CollectionsApi::Context::default();
- let result = client.createCollection(accept, contentType, collection, &context).wait();
+ let mut context = DecoratorsApi::Context::default();
+ let result = client.updateDecorator(accept, contentType, decorator, &context).wait();
println!("{:?}", result);
}
@@ -2565,7 +2601,7 @@ pub fn main() {
-
+
@@ -2585,7 +2621,7 @@ pub fn main() {
-
+
@@ -2609,7 +2645,7 @@ pub fn main() {
Name
Description
- collection *
+ decorator *
-
+
@@ -2663,50 +2696,34 @@ $(document).ready(function() {
Responses
-
-
+
+
-
- -
- Schema
-
-
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
+ EntitiesAndRelationships
+
+
- deleteCollection
- Delete a collection with specified id.
+ getAllDomains
+ Get all the available topology domains.
- Delete a collection with specified id.
+ Get all the available topology domains.
- /collections/{collectionId}
+ /domains
Usage and SDK Samples
- - Curl
- - Java
- - Dart
- - Android
-
- - Obj-C
- - JavaScript
-
- - C#
- - PHP
- - Perl
- - Python
- - Rust
+ - Curl
+ - Java
+ - Dart
+ - Android
+
+ - Obj-C
+ - JavaScript
+
+ - C#
+ - PHP
+ - Perl
+ - Python
+ - Rust
-
- curl -X DELETE \
- -H "Accept: application/problem+json" \
- "https://localhost/topology-inventory/v1alpha11/collections/{collectionId}"
+
+ 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.CollectionsApi;
+import org.openapitools.client.api.EntitiesAndRelationshipsApi;
import java.io.File;
import java.util.*;
-public class CollectionsApiExample {
+public class EntitiesAndRelationshipsApiExample {
public static void main(String[] args) {
// Create an instance of the API class
- CollectionsApi apiInstance = new CollectionsApi();
+ EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
String accept = application/json; // String |
- String collectionId = collectionId_example; // String |
+ Integer offset = 56; // Integer | Pagination offset.
+ Integer limit = 56; // Integer | Result limiter.
try {
- apiInstance.deleteCollection(accept, collectionId);
+ Domains result = apiInstance.getAllDomains(accept, offset, limit);
+ System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling CollectionsApi#deleteCollection");
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getAllDomains");
e.printStackTrace();
}
}
@@ -3219,58 +3241,66 @@ public class CollectionsApiExample {
-
+
import 'package:openapi/api.dart';
final api_instance = DefaultApi();
final String accept = new String(); // String |
-final String collectionId = 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.deleteCollection(accept, collectionId);
+ final result = await api_instance.getAllDomains(accept, offset, limit);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->deleteCollection: $e\n');
+ print('Exception when calling DefaultApi->getAllDomains: $e\n');
}
-
- import org.openapitools.client.api.CollectionsApi;
+
+ import org.openapitools.client.api.EntitiesAndRelationshipsApi;
-public class CollectionsApiExample {
+public class EntitiesAndRelationshipsApiExample {
public static void main(String[] args) {
- CollectionsApi apiInstance = new CollectionsApi();
+ EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
String accept = application/json; // String |
- String collectionId = collectionId_example; // String |
+ Integer offset = 56; // Integer | Pagination offset.
+ Integer limit = 56; // Integer | Result limiter.
try {
- apiInstance.deleteCollection(accept, collectionId);
+ Domains result = apiInstance.getAllDomains(accept, offset, limit);
+ System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling CollectionsApi#deleteCollection");
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getAllDomains");
e.printStackTrace();
}
}
}
-
+
// Create an instance of the API class
-CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
+EntitiesAndRelationshipsApi *apiInstance = [[EntitiesAndRelationshipsApi alloc] init];
String *accept = application/json; // (default to application/json)
-String *collectionId = collectionId_example; // (default to null)
+Integer *offset = 56; // Pagination offset. (optional) (default to 0)
+Integer *limit = 56; // Result limiter. (optional) (default to 500)
-// Delete a collection with specified id.
-[apiInstance deleteCollectionWith:accept
- collectionId:collectionId
- completionHandler: ^(NSError* error) {
+// 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);
}
@@ -3278,29 +3308,32 @@ String *collectionId = collectionId_example; // (default to null)
-
- var TopologyAndInventoryApi = require('topology_and_inventory_api');
+
+ var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
-var api = new TopologyAndInventoryApi.CollectionsApi()
+var api = new TopologyExposureAndInventoryApi.EntitiesAndRelationshipsApi()
var accept = application/json; // {String}
-var collectionId = collectionId_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.');
+ console.log('API called successfully. Returned data: ' + data);
}
};
-api.deleteCollection(accept, collectionId, callback);
+api.getAllDomains(accept, opts, callback);
-
-
+
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
@@ -3309,21 +3342,23 @@ using Org.OpenAPITools.Model;
namespace Example
{
- public class deleteCollectionExample
+ public class getAllDomainsExample
{
public void main()
{
// Create an instance of the API class
- var apiInstance = new CollectionsApi();
+ var apiInstance = new EntitiesAndRelationshipsApi();
var accept = application/json; // String | (default to application/json)
- var collectionId = collectionId_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 {
- // Delete a collection with specified id.
- apiInstance.deleteCollection(accept, collectionId);
+ // Get all the available topology domains.
+ Domains result = apiInstance.getAllDomains(accept, offset, limit);
+ Debug.WriteLine(result);
} catch (Exception e) {
- Debug.Print("Exception when calling CollectionsApi.deleteCollection: " + e.Message );
+ Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getAllDomains: " + e.Message );
}
}
}
@@ -3331,42 +3366,46 @@ namespace Example
-
+
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Create an instance of the API class
-$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
+$api_instance = new OpenAPITools\Client\Api\EntitiesAndRelationshipsApi();
$accept = application/json; // String |
-$collectionId = collectionId_example; // String |
+$offset = 56; // Integer | Pagination offset.
+$limit = 56; // Integer | Result limiter.
try {
- $api_instance->deleteCollection($accept, $collectionId);
+ $result = $api_instance->getAllDomains($accept, $offset, $limit);
+ print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling CollectionsApi->deleteCollection: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling EntitiesAndRelationshipsApi->getAllDomains: ', $e->getMessage(), PHP_EOL;
}
?>
-
+
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::CollectionsApi;
+use WWW::OPenAPIClient::EntitiesAndRelationshipsApi;
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
+my $api_instance = WWW::OPenAPIClient::EntitiesAndRelationshipsApi->new();
my $accept = application/json; # String |
-my $collectionId = collectionId_example; # String |
+my $offset = 56; # Integer | Pagination offset.
+my $limit = 56; # Integer | Result limiter.
eval {
- $api_instance->deleteCollection(accept => $accept, collectionId => $collectionId);
+ my $result = $api_instance->getAllDomains(accept => $accept, offset => $offset, limit => $limit);
+ print Dumper($result);
};
if ($@) {
- warn "Exception when calling CollectionsApi->deleteCollection: $@\n";
+ warn "Exception when calling EntitiesAndRelationshipsApi->getAllDomains: $@\n";
}
-
+
from __future__ import print_statement
import time
import openapi_client
@@ -3374,26 +3413,29 @@ from openapi_client.rest import ApiException
from pprint import pprint
# Create an instance of the API class
-api_instance = openapi_client.CollectionsApi()
+api_instance = openapi_client.EntitiesAndRelationshipsApi()
accept = application/json # String | (default to application/json)
-collectionId = collectionId_example # String | (default to null)
+offset = 56 # Integer | Pagination offset. (optional) (default to 0)
+limit = 56 # Integer | Result limiter. (optional) (default to 500)
try:
- # Delete a collection with specified id.
- api_instance.delete_collection(accept, collectionId)
+ # 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 CollectionsApi->deleteCollection: %s\n" % e)
+ print("Exception when calling EntitiesAndRelationshipsApi->getAllDomains: %s\n" % e)
-
- extern crate CollectionsApi;
+
+ extern crate EntitiesAndRelationshipsApi;
pub fn main() {
let accept = application/json; // String
- let collectionId = collectionId_example; // String
+ let offset = 56; // Integer
+ let limit = 56; // Integer
- let mut context = CollectionsApi::Context::default();
- let result = client.deleteCollection(accept, collectionId, &context).wait();
+ let mut context = EntitiesAndRelationshipsApi::Context::default();
+ let result = client.getAllDomains(accept, offset, limit, &context).wait();
println!("{:?}", result);
}
@@ -3408,17 +3450,18 @@ pub fn main() {
Parameters
- Path parameters
+
+ Header parameters
-
- Name
- Description
-
- collectionId*
+
+ Name
+ Description
+
+ Accept*
-
+
@@ -3436,120 +3479,74 @@ pub fn main() {
- Header parameters
+
+
+ Query parameters
Name
Description
- Accept*
+ offset
-
+
- String
+ Integer
+
+Pagination offset.
+
-
- Required
-
-
+ limit
+
+
+
+
+
+ Integer
+
+
+
+Result limiter.
+
+
+
+
+
+
+
Responses
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
- getAllCollections
- Get all collections.
+ getAllRelationshipsForEntityId
+ Get all relationships for entity type name with specified id. Specified id represents the entity instance.
- Get all collections.
+ Get all relationships for entity type name with specified id. Specified id represents the entity instance.
- /collections
+ /domains/{domainName}/entity-types/{entityTypeName}/entities/{entityId}/relationships
Usage and SDK Samples
- - Curl
- - Java
- - Dart
- - Android
-
- - Obj-C
- - JavaScript
-
- - C#
- - PHP
- - Perl
- - Python
- - Rust
+ - Curl
+ - Java
+ - Dart
+ - Android
+
+ - Obj-C
+ - JavaScript
+
+ - C#
+ - PHP
+ - Perl
+ - Python
+ - Rust
-
+
curl -X GET \
-H "Accept: application/json,application/problem+json" \
- "https://localhost/topology-inventory/v1alpha11/collections?offset=56&limit=56"
+ "https://localhost/topology-inventory/v1alpha11/domains/{domainName}/entity-types/{entityTypeName}/entities/{entityId}/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.CollectionsApi;
+import org.openapitools.client.api.EntitiesAndRelationshipsApi;
import java.io.File;
import java.util.*;
-public class CollectionsApiExample {
+public class EntitiesAndRelationshipsApiExample {
public static void main(String[] args) {
// Create an instance of the API class
- CollectionsApi apiInstance = new CollectionsApi();
+ 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 |
+ 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 {
- Collections result = apiInstance.getAllCollections(accept, offset, limit);
+ RelationshipsResponseMessage result = apiInstance.getAllRelationshipsForEntityId(accept, domainName, entityTypeName, entityId, targetFilter, scopeFilter, offset, limit);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling CollectionsApi#getAllCollections");
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getAllRelationshipsForEntityId");
e.printStackTrace();
}
}
@@ -4010,63 +4012,83 @@ public class CollectionsApiExample {
-
+
import 'package:openapi/api.dart';
final api_instance = DefaultApi();
final String accept = new String(); // String |
+final String domainName = new String(); // String | domain name
+final String entityTypeName = new String(); // String |
+final String entityId = new String(); // String |
+final String targetFilter = new String(); // String | Use *targetFilter* to specify 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.getAllCollections(accept, offset, limit);
+ final result = await api_instance.getAllRelationshipsForEntityId(accept, domainName, entityTypeName, entityId, targetFilter, scopeFilter, offset, limit);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->getAllCollections: $e\n');
+ print('Exception when calling DefaultApi->getAllRelationshipsForEntityId: $e\n');
}
-
- import org.openapitools.client.api.CollectionsApi;
+
+ import org.openapitools.client.api.EntitiesAndRelationshipsApi;
-public class CollectionsApiExample {
+public class EntitiesAndRelationshipsApiExample {
public static void main(String[] args) {
- CollectionsApi apiInstance = new CollectionsApi();
+ 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 |
+ 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 {
- Collections result = apiInstance.getAllCollections(accept, offset, limit);
+ RelationshipsResponseMessage result = apiInstance.getAllRelationshipsForEntityId(accept, domainName, entityTypeName, entityId, targetFilter, scopeFilter, offset, limit);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling CollectionsApi#getAllCollections");
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getAllRelationshipsForEntityId");
e.printStackTrace();
}
}
}
-
+
// Create an instance of the API class
-CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
+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)
+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 collections.
-[apiInstance getAllCollectionsWith:accept
+// 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
+ targetFilter:targetFilter
+ scopeFilter:scopeFilter
offset:offset
limit:limit
- completionHandler: ^(Collections output, NSError* error) {
+ completionHandler: ^(RelationshipsResponseMessage output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
@@ -4077,13 +4099,18 @@ Integer *limit = 56; // Result limiter. (optional) (default to 500)
-
- var TopologyAndInventoryApi = require('topology_and_inventory_api');
+
+ var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
-var api = new TopologyAndInventoryApi.CollectionsApi()
+var api = new TopologyExposureAndInventoryApi.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 = {
+ '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.
};
@@ -4095,14 +4122,14 @@ var callback = function(error, data, response) {
console.log('API called successfully. Returned data: ' + data);
}
};
-api.getAllCollections(accept, opts, callback);
+api.getAllRelationshipsForEntityId(accept, domainName, entityTypeName, entityId, opts, callback);
-
-
+
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
@@ -4111,23 +4138,28 @@ using Org.OpenAPITools.Model;
namespace Example
{
- public class getAllCollectionsExample
+ public class getAllRelationshipsForEntityIdExample
{
public void main()
{
// Create an instance of the API class
- var apiInstance = new CollectionsApi();
+ 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 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 collections.
- Collections result = apiInstance.getAllCollections(accept, offset, limit);
+ // Get all relationships for entity type name with specified id. Specified id represents the entity instance.
+ RelationshipsResponseMessage result = apiInstance.getAllRelationshipsForEntityId(accept, domainName, entityTypeName, entityId, targetFilter, scopeFilter, offset, limit);
Debug.WriteLine(result);
} catch (Exception e) {
- Debug.Print("Exception when calling CollectionsApi.getAllCollections: " + e.Message );
+ Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getAllRelationshipsForEntityId: " + e.Message );
}
}
}
@@ -4135,46 +4167,56 @@ namespace Example
-
+
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Create an instance of the API class
-$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
+$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 |
+$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->getAllCollections($accept, $offset, $limit);
+ $result = $api_instance->getAllRelationshipsForEntityId($accept, $domainName, $entityTypeName, $entityId, $targetFilter, $scopeFilter, $offset, $limit);
print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling CollectionsApi->getAllCollections: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling EntitiesAndRelationshipsApi->getAllRelationshipsForEntityId: ', $e->getMessage(), PHP_EOL;
}
?>
-
+
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::CollectionsApi;
+use WWW::OPenAPIClient::EntitiesAndRelationshipsApi;
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
+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 $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->getAllCollections(accept => $accept, offset => $offset, limit => $limit);
+ my $result = $api_instance->getAllRelationshipsForEntityId(accept => $accept, domainName => $domainName, entityTypeName => $entityTypeName, entityId => $entityId, targetFilter => $targetFilter, scopeFilter => $scopeFilter, offset => $offset, limit => $limit);
print Dumper($result);
};
if ($@) {
- warn "Exception when calling CollectionsApi->getAllCollections: $@\n";
+ warn "Exception when calling EntitiesAndRelationshipsApi->getAllRelationshipsForEntityId: $@\n";
}
-
+
from __future__ import print_statement
import time
import openapi_client
@@ -4182,29 +4224,39 @@ from openapi_client.rest import ApiException
from pprint import pprint
# Create an instance of the API class
-api_instance = openapi_client.CollectionsApi()
+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)
+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 collections.
- api_response = api_instance.get_all_collections(accept, offset=offset, limit=limit)
+ # 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, targetFilter=targetFilter, scopeFilter=scopeFilter, offset=offset, limit=limit)
pprint(api_response)
except ApiException as e:
- print("Exception when calling CollectionsApi->getAllCollections: %s\n" % e)
+ print("Exception when calling EntitiesAndRelationshipsApi->getAllRelationshipsForEntityId: %s\n" % e)
-
- extern crate CollectionsApi;
+
+ 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 targetFilter = /attributes(nCI,nRPCI); // String
+ let scopeFilter = /attributes[@nRTAC=310]; // String
let offset = 56; // Integer
let limit = 56; // Integer
- let mut context = CollectionsApi::Context::default();
- let result = client.getAllCollections(accept, offset, limit, &context).wait();
+ let mut context = EntitiesAndRelationshipsApi::Context::default();
+ let result = client.getAllRelationshipsForEntityId(accept, domainName, entityTypeName, entityId, targetFilter, scopeFilter, offset, limit, &context).wait();
println!("{:?}", result);
}
@@ -4219,6 +4271,76 @@ pub fn main() {
Parameters
+ Path parameters
+
+
+ Name
+ Description
+
+ domainName*
+
+
+
+
+
+
+
+ String
+
+
+
+domain name
+
+
+
+ Required
+
+
+
+
+
+
+ entityTypeName*
+
+
+
+
+
+
+
+ String
+
+
+
+
+ Required
+
+
+
+
+
+
+ entityId*
+
+
+
+
+
+
+
+ String
+
+
+
+
+ Required
+
+
+
+
+
+
+
Header parameters
@@ -4230,7 +4352,7 @@ pub fn main() {
-
+
@@ -4256,11 +4378,51 @@ pub fn main() {
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
-
+
@@ -4280,7 +4442,7 @@ Pagination offset.
-
+
@@ -4299,23 +4461,23 @@ Result limiter.
Responses
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
+ -
+ Schema
+
+
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
+ var responseEntitiesAndRelationships500_description = `Internal Server Error`;
+ var responseEntitiesAndRelationships500_description_break = responseEntitiesAndRelationships500_description.indexOf('\n');
+ if (responseEntitiesAndRelationships500_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description);
+ } else {
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description.substring(0, responseEntitiesAndRelationships500_description_break));
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-500").html(responseEntitiesAndRelationships500_description.substring(responseEntitiesAndRelationships500_description_break));
+ }
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
- getCollection
- Get a collection with specified id.
+ getEntitiesByDomain
+ Get entities by domain
- Get a collection with specified id.
+ Get topology entities by domain, using specified targetFilter as mandatory query parameter.
- /collections/{collectionId}
+ /domains/{domainName}/entities
Usage and SDK Samples
- - Curl
- - Java
- - Dart
- - Android
-
- - Obj-C
- - JavaScript
-
- - C#
- - PHP
- - Perl
- - Python
- - Rust
+ - Curl
+ - Java
+ - Dart
+ - Android
+
+ - Obj-C
+ - JavaScript
+
+ - C#
+ - PHP
+ - Perl
+ - Python
+ - Rust
-
+
curl -X GET \
-H "Accept: application/json,application/problem+json" \
- "https://localhost/topology-inventory/v1alpha11/collections/{collectionId}"
+ "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.CollectionsApi;
+import org.openapitools.client.api.EntitiesAndRelationshipsApi;
import java.io.File;
import java.util.*;
-public class CollectionsApiExample {
+public class EntitiesAndRelationshipsApiExample {
public static void main(String[] args) {
// Create an instance of the API class
- CollectionsApi apiInstance = new CollectionsApi();
+ EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
String accept = application/json; // String |
- String collectionId = collectionId_example; // 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 {
- CollectionResponse result = apiInstance.getCollection(accept, collectionId);
+ EntitiesResponseMessage result = apiInstance.getEntitiesByDomain(accept, domainName, targetFilter, scopeFilter, offset, limit);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling CollectionsApi#getCollection");
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getEntitiesByDomain");
e.printStackTrace();
}
}
@@ -4840,59 +5022,75 @@ public class CollectionsApiExample {
-
+
import 'package:openapi/api.dart';
final api_instance = DefaultApi();
final String accept = new String(); // String |
-final String collectionId = 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.getCollection(accept, collectionId);
+ final result = await api_instance.getEntitiesByDomain(accept, domainName, targetFilter, scopeFilter, offset, limit);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->getCollection: $e\n');
+ print('Exception when calling DefaultApi->getEntitiesByDomain: $e\n');
}
-
- import org.openapitools.client.api.CollectionsApi;
+
+ import org.openapitools.client.api.EntitiesAndRelationshipsApi;
-public class CollectionsApiExample {
+public class EntitiesAndRelationshipsApiExample {
public static void main(String[] args) {
- CollectionsApi apiInstance = new CollectionsApi();
+ EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
String accept = application/json; // String |
- String collectionId = collectionId_example; // 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 {
- CollectionResponse result = apiInstance.getCollection(accept, collectionId);
+ EntitiesResponseMessage result = apiInstance.getEntitiesByDomain(accept, domainName, targetFilter, scopeFilter, offset, limit);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling CollectionsApi#getCollection");
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getEntitiesByDomain");
e.printStackTrace();
}
}
}
-
+
// Create an instance of the API class
-CollectionsApi *apiInstance = [[CollectionsApi alloc] init];
+EntitiesAndRelationshipsApi *apiInstance = [[EntitiesAndRelationshipsApi alloc] init];
String *accept = application/json; // (default to application/json)
-String *collectionId = collectionId_example; // (default to null)
+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 a collection with specified id.
-[apiInstance getCollectionWith:accept
- collectionId:collectionId
- completionHandler: ^(CollectionResponse output, NSError* error) {
+// 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);
}
@@ -4903,13 +5101,19 @@ String *collectionId = collectionId_example; // (default to null)
-
- var TopologyAndInventoryApi = require('topology_and_inventory_api');
+
+ var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
-var api = new TopologyAndInventoryApi.CollectionsApi()
+var api = new TopologyExposureAndInventoryApi.EntitiesAndRelationshipsApi()
var accept = application/json; // {String}
-var collectionId = collectionId_example; // {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) {
@@ -4918,14 +5122,14 @@ var callback = function(error, data, response) {
console.log('API called successfully. Returned data: ' + data);
}
};
-api.getCollection(accept, collectionId, callback);
+api.getEntitiesByDomain(accept, domainName, opts, callback);
-
-
+
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
@@ -4934,22 +5138,26 @@ using Org.OpenAPITools.Model;
namespace Example
{
- public class getCollectionExample
+ public class getEntitiesByDomainExample
{
public void main()
{
// Create an instance of the API class
- var apiInstance = new CollectionsApi();
+ var apiInstance = new EntitiesAndRelationshipsApi();
var accept = application/json; // String | (default to application/json)
- var collectionId = collectionId_example; // String | (default to null)
+ 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 a collection with specified id.
- CollectionResponse result = apiInstance.getCollection(accept, collectionId);
+ // 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 CollectionsApi.getCollection: " + e.Message );
+ Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getEntitiesByDomain: " + e.Message );
}
}
}
@@ -4957,44 +5165,52 @@ namespace Example
-
+
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Create an instance of the API class
-$api_instance = new OpenAPITools\Client\Api\CollectionsApi();
+$api_instance = new OpenAPITools\Client\Api\EntitiesAndRelationshipsApi();
$accept = application/json; // String |
-$collectionId = collectionId_example; // 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->getCollection($accept, $collectionId);
+ $result = $api_instance->getEntitiesByDomain($accept, $domainName, $targetFilter, $scopeFilter, $offset, $limit);
print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling CollectionsApi->getCollection: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling EntitiesAndRelationshipsApi->getEntitiesByDomain: ', $e->getMessage(), PHP_EOL;
}
?>
-
+
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::CollectionsApi;
+use WWW::OPenAPIClient::EntitiesAndRelationshipsApi;
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::CollectionsApi->new();
+my $api_instance = WWW::OPenAPIClient::EntitiesAndRelationshipsApi->new();
my $accept = application/json; # String |
-my $collectionId = collectionId_example; # 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->getCollection(accept => $accept, collectionId => $collectionId);
+ 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 CollectionsApi->getCollection: $@\n";
+ warn "Exception when calling EntitiesAndRelationshipsApi->getEntitiesByDomain: $@\n";
}
-
+
from __future__ import print_statement
import time
import openapi_client
@@ -5002,27 +5218,35 @@ from openapi_client.rest import ApiException
from pprint import pprint
# Create an instance of the API class
-api_instance = openapi_client.CollectionsApi()
+api_instance = openapi_client.EntitiesAndRelationshipsApi()
accept = application/json # String | (default to application/json)
-collectionId = collectionId_example # String | (default to null)
+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 a collection with specified id.
- api_response = api_instance.get_collection(accept, collectionId)
+ # 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 CollectionsApi->getCollection: %s\n" % e)
+ print("Exception when calling EntitiesAndRelationshipsApi->getEntitiesByDomain: %s\n" % e)
-
- extern crate CollectionsApi;
+
+ extern crate EntitiesAndRelationshipsApi;
pub fn main() {
let accept = application/json; // String
- let collectionId = collectionId_example; // 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 = CollectionsApi::Context::default();
- let result = client.getCollection(accept, collectionId, &context).wait();
+ let mut context = EntitiesAndRelationshipsApi::Context::default();
+ let result = client.getEntitiesByDomain(accept, domainName, targetFilter, scopeFilter, offset, limit, &context).wait();
println!("{:?}", result);
}
@@ -5043,17 +5267,20 @@ pub fn main() {
Name
Description
- collectionId*
+ domainName*
-
+
String
+
+domain name
+
Required
@@ -5075,7 +5302,7 @@ pub fn main() {
-
+
@@ -5095,25 +5322,112 @@ pub fn main() {
+ 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
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
-
-
-
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
-
-
-
-
-
-
-
-
-
- -
- Schema
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
- updateCollection
- Update a collection.
+ getRelationshipById
+ Get relationship with specified id. Specified id represents the relationship instance.
- Update a collection.
+ Get relationship with specified id. Specified id represents the relationship instance.
- /collections/{collectionId}
+ /domains/{domainName}/relationship-types/{relationshipTypeName}/relationships/{relationshipId}
Usage and SDK Samples
- - Curl
- - Java
- - Dart
- - Android
-
- - Obj-C
- - JavaScript
-
- - C#
- - PHP
- - Perl
- - Python
- - Rust
+ - Curl
+ - Java
+ - Dart
+ - Android
+
+ - Obj-C
+ - JavaScript
+
+ - C#
+ - PHP
+ - Perl
+ - Python
+ - Rust
-
- 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"
-}'
+
+ 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.CollectionsApi;
+import org.openapitools.client.api.EntitiesAndRelationshipsApi;
import java.io.File;
import java.util.*;
-public class CollectionsApiExample {
+public class EntitiesAndRelationshipsApiExample {
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 |
+ EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
+ String accept = application/yang.data+json; // String |
+ String domainName = domainName_example; // String | domain name
+ String relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String |
+ String relationshipId = relationshipId_example; // String |
try {
- apiInstance.updateCollection(accept, contentType, collectionId, collection);
+ Object result = apiInstance.getRelationshipById(accept, domainName, relationshipTypeName, relationshipId);
+ System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling CollectionsApi#updateCollection");
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getRelationshipById");
e.printStackTrace();
}
}
@@ -5662,66 +5889,70 @@ public class CollectionsApiExample {
-
+
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 |
+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.updateCollection(accept, contentType, collectionId, collection);
+ final result = await api_instance.getRelationshipById(accept, domainName, relationshipTypeName, relationshipId);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->updateCollection: $e\n');
+ print('Exception when calling DefaultApi->getRelationshipById: $e\n');
}
-
- import org.openapitools.client.api.CollectionsApi;
+
+ import org.openapitools.client.api.EntitiesAndRelationshipsApi;
-public class CollectionsApiExample {
+public class EntitiesAndRelationshipsApiExample {
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 |
+ EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
+ String accept = application/yang.data+json; // String |
+ String domainName = domainName_example; // String | domain name
+ String relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String |
+ String relationshipId = relationshipId_example; // String |
try {
- apiInstance.updateCollection(accept, contentType, collectionId, collection);
+ Object result = apiInstance.getRelationshipById(accept, domainName, relationshipTypeName, relationshipId);
+ System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling CollectionsApi#updateCollection");
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getRelationshipById");
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 = ; //
+EntitiesAndRelationshipsApi *apiInstance = [[EntitiesAndRelationshipsApi alloc] init];
+String *accept = application/yang.data+json; // (default to application/yang.data+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)
-// Update a collection.
-[apiInstance updateCollectionWith:accept
- contentType:contentType
- collectionId:collectionId
- collection:collection
- completionHandler: ^(NSError* error) {
+// 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);
}
@@ -5729,31 +5960,31 @@ Collection *collection = ; //
-
- var TopologyAndInventoryApi = require('topology_and_inventory_api');
+
+ var TopologyExposureAndInventoryApi = require('topology_exposure_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 api = new TopologyExposureAndInventoryApi.EntitiesAndRelationshipsApi()
+var accept = application/yang.data+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.');
+ console.log('API called successfully. Returned data: ' + data);
}
};
-api.updateCollection(accept, contentType, collectionId, collection, callback);
+api.getRelationshipById(accept, domainName, relationshipTypeName, relationshipId, callback);
-
-
+
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
@@ -5762,23 +5993,24 @@ using Org.OpenAPITools.Model;
namespace Example
{
- public class updateCollectionExample
+ public class getRelationshipByIdExample
{
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 |
+ var apiInstance = new EntitiesAndRelationshipsApi();
+ var accept = application/yang.data+json; // String | (default to application/yang.data+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 {
- // Update a collection.
- apiInstance.updateCollection(accept, contentType, collectionId, collection);
+ // 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 CollectionsApi.updateCollection: " + e.Message );
+ Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getRelationshipById: " + e.Message );
}
}
}
@@ -5786,46 +6018,48 @@ namespace Example
-
+
<?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 |
+$api_instance = new OpenAPITools\Client\Api\EntitiesAndRelationshipsApi();
+$accept = application/yang.data+json; // String |
+$domainName = domainName_example; // String | domain name
+$relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String |
+$relationshipId = relationshipId_example; // String |
try {
- $api_instance->updateCollection($accept, $contentType, $collectionId, $collection);
+ $result = $api_instance->getRelationshipById($accept, $domainName, $relationshipTypeName, $relationshipId);
+ print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling CollectionsApi->updateCollection: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling EntitiesAndRelationshipsApi->getRelationshipById: ', $e->getMessage(), PHP_EOL;
}
?>
-
+
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::CollectionsApi;
+use WWW::OPenAPIClient::EntitiesAndRelationshipsApi;
# 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 |
+my $api_instance = WWW::OPenAPIClient::EntitiesAndRelationshipsApi->new();
+my $accept = application/yang.data+json; # String |
+my $domainName = domainName_example; # String | domain name
+my $relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; # String |
+my $relationshipId = relationshipId_example; # String |
eval {
- $api_instance->updateCollection(accept => $accept, contentType => $contentType, collectionId => $collectionId, collection => $collection);
+ my $result = $api_instance->getRelationshipById(accept => $accept, domainName => $domainName, relationshipTypeName => $relationshipTypeName, relationshipId => $relationshipId);
+ print Dumper($result);
};
if ($@) {
- warn "Exception when calling CollectionsApi->updateCollection: $@\n";
+ warn "Exception when calling EntitiesAndRelationshipsApi->getRelationshipById: $@\n";
}
-
+
from __future__ import print_statement
import time
import openapi_client
@@ -5833,30 +6067,31 @@ 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 |
+api_instance = openapi_client.EntitiesAndRelationshipsApi()
+accept = application/yang.data+json # String | (default to application/yang.data+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:
- # Update a collection.
- api_instance.update_collection(accept, contentType, collectionId, collection)
+ # 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 CollectionsApi->updateCollection: %s\n" % e)
+ print("Exception when calling EntitiesAndRelationshipsApi->getRelationshipById: %s\n" % e)
-
- extern crate CollectionsApi;
-
+
+ extern crate EntitiesAndRelationshipsApi;
+
pub fn main() {
- let accept = application/json; // String
- let contentType = application/json; // String
- let collectionId = collectionId_example; // String
- let collection = ; // Collection
+ let accept = application/yang.data+json; // String
+ let domainName = domainName_example; // String
+ let relationshipTypeName = NRCELLDU_USES_NRSECTORCARRIER; // String
+ let relationshipId = relationshipId_example; // String
- let mut context = CollectionsApi::Context::default();
- let result = client.updateCollection(accept, contentType, collectionId, collection, &context).wait();
+ let mut context = EntitiesAndRelationshipsApi::Context::default();
+ let result = client.getRelationshipById(accept, domainName, relationshipTypeName, relationshipId, &context).wait();
println!("{:?}", result);
}
@@ -5877,17 +6112,20 @@ pub fn main() {
Name
Description
- collectionId*
+ domainName*
-
+
String
+
+domain name
+
Required
@@ -5897,19 +6135,11 @@ pub fn main() {
-
-
- Header parameters
-
-
- Name
- Description
-
- Accept*
+ relationshipTypeName*
-
+
@@ -5925,11 +6155,11 @@ pub fn main() {
- Content-Type*
+ relationshipId*
-
+
@@ -5947,58 +6177,29 @@ pub fn main() {
- Body parameters
+ Header parameters
Name
Description
- collection *
+ Accept*
-
-
-
+
+
+
+
+ String
+
+
+
+
+ Required
+
+
+
@@ -6006,35 +6207,53 @@ $(document).ready(function() {
+
Responses
-
-
+
+
-
+
+ -
+ Schema
+
+
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
- Decorators
-
-
+
+
- updateDecorator
- Update entities and/or relationships with decorator(s).
+ getRelationshipsByType
+ Get topology relationships of a specific relationship type name.
- Update entities and/or relationships with decorator(s).
+ Get topology relationships of a specific relationship type name.
- /decorators
+ /domains/{domainName}/relationship-types/{relationshipTypeName}/relationships
Usage and SDK Samples
- - Curl
- - Java
- - Dart
- - Android
-
- - Obj-C
- - JavaScript
-
- - C#
- - PHP
- - Perl
- - Python
- - Rust
+ - Curl
+ - Java
+ - Dart
+ - Android
+
+ - Obj-C
+ - JavaScript
+
+ - C#
+ - PHP
+ - Perl
+ - Python
+ - Rust
-
- 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" ]
-}'
-
+
+ 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.DecoratorsApi;
+import org.openapitools.client.api.EntitiesAndRelationshipsApi;
import java.io.File;
import java.util.*;
-public class DecoratorsApiExample {
+public class EntitiesAndRelationshipsApiExample {
public static void main(String[] args) {
// Create an instance of the API class
- DecoratorsApi apiInstance = new DecoratorsApi();
+ EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
String accept = application/json; // String |
- String contentType = application/json; // String |
- Decorator decorator = ; // Decorator |
+ 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 {
- apiInstance.updateDecorator(accept, contentType, decorator);
+ RelationshipsResponseMessage result = apiInstance.getRelationshipsByType(accept, domainName, relationshipTypeName, targetFilter, scopeFilter, offset, limit);
+ System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling DecoratorsApi#updateDecorator");
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getRelationshipsByType");
e.printStackTrace();
}
}
@@ -6560,62 +6772,82 @@ public class DecoratorsApiExample {
-
+
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 |
+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.updateDecorator(accept, contentType, decorator);
+ final result = await api_instance.getRelationshipsByType(accept, domainName, relationshipTypeName, targetFilter, scopeFilter, offset, limit);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->updateDecorator: $e\n');
+ print('Exception when calling DefaultApi->getRelationshipsByType: $e\n');
}
-
- import org.openapitools.client.api.DecoratorsApi;
+
+ import org.openapitools.client.api.EntitiesAndRelationshipsApi;
-public class DecoratorsApiExample {
+public class EntitiesAndRelationshipsApiExample {
public static void main(String[] args) {
- DecoratorsApi apiInstance = new DecoratorsApi();
+ EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
String accept = application/json; // String |
- String contentType = application/json; // String |
- Decorator decorator = ; // Decorator |
+ 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 {
- apiInstance.updateDecorator(accept, contentType, decorator);
+ RelationshipsResponseMessage result = apiInstance.getRelationshipsByType(accept, domainName, relationshipTypeName, targetFilter, scopeFilter, offset, limit);
+ System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling DecoratorsApi#updateDecorator");
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getRelationshipsByType");
e.printStackTrace();
}
}
}
-
+
// Create an instance of the API class
-DecoratorsApi *apiInstance = [[DecoratorsApi alloc] init];
+EntitiesAndRelationshipsApi *apiInstance = [[EntitiesAndRelationshipsApi alloc] init];
String *accept = application/json; // (default to application/json)
-String *contentType = application/json; // (default to application/json)
-Decorator *decorator = ; //
+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)
-// Update entities and/or relationships with decorator(s).
-[apiInstance updateDecoratorWith:accept
- contentType:contentType
- decorator:decorator
- completionHandler: ^(NSError* error) {
+// 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);
}
@@ -6623,30 +6855,36 @@ Decorator *decorator = ; //
-
- var TopologyAndInventoryApi = require('topology_and_inventory_api');
+
+ var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
-var api = new TopologyAndInventoryApi.DecoratorsApi()
+var api = new TopologyExposureAndInventoryApi.EntitiesAndRelationshipsApi()
var accept = application/json; // {String}
-var contentType = application/json; // {String}
-var decorator = ; // {Decorator}
+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.');
+ console.log('API called successfully. Returned data: ' + data);
}
};
-api.updateDecorator(accept, contentType, decorator, callback);
+api.getRelationshipsByType(accept, domainName, relationshipTypeName, opts, callback);
-
-
+
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
@@ -6655,22 +6893,27 @@ using Org.OpenAPITools.Model;
namespace Example
{
- public class updateDecoratorExample
+ public class getRelationshipsByTypeExample
{
public void main()
{
// Create an instance of the API class
- var apiInstance = new DecoratorsApi();
+ var apiInstance = new EntitiesAndRelationshipsApi();
var accept = application/json; // String | (default to application/json)
- var contentType = application/json; // String | (default to application/json)
- var decorator = new Decorator(); // Decorator |
+ 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 {
- // Update entities and/or relationships with decorator(s).
- apiInstance.updateDecorator(accept, contentType, decorator);
+ // 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 DecoratorsApi.updateDecorator: " + e.Message );
+ Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getRelationshipsByType: " + e.Message );
}
}
}
@@ -6678,44 +6921,54 @@ namespace Example
-
+
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Create an instance of the API class
-$api_instance = new OpenAPITools\Client\Api\DecoratorsApi();
+$api_instance = new OpenAPITools\Client\Api\EntitiesAndRelationshipsApi();
$accept = application/json; // String |
-$contentType = application/json; // String |
-$decorator = ; // Decorator |
+$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 {
- $api_instance->updateDecorator($accept, $contentType, $decorator);
+ $result = $api_instance->getRelationshipsByType($accept, $domainName, $relationshipTypeName, $targetFilter, $scopeFilter, $offset, $limit);
+ print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling DecoratorsApi->updateDecorator: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling EntitiesAndRelationshipsApi->getRelationshipsByType: ', $e->getMessage(), PHP_EOL;
}
?>
-
+
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::DecoratorsApi;
+use WWW::OPenAPIClient::EntitiesAndRelationshipsApi;
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::DecoratorsApi->new();
+my $api_instance = WWW::OPenAPIClient::EntitiesAndRelationshipsApi->new();
my $accept = application/json; # String |
-my $contentType = application/json; # String |
-my $decorator = WWW::OPenAPIClient::Object::Decorator->new(); # Decorator |
+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 {
- $api_instance->updateDecorator(accept => $accept, contentType => $contentType, decorator => $decorator);
+ 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 DecoratorsApi->updateDecorator: $@\n";
+ warn "Exception when calling EntitiesAndRelationshipsApi->getRelationshipsByType: $@\n";
}
-
+
from __future__ import print_statement
import time
import openapi_client
@@ -6723,28 +6976,37 @@ from openapi_client.rest import ApiException
from pprint import pprint
# Create an instance of the API class
-api_instance = openapi_client.DecoratorsApi()
+api_instance = openapi_client.EntitiesAndRelationshipsApi()
accept = application/json # String | (default to application/json)
-contentType = application/json # String | (default to application/json)
-decorator = # Decorator |
+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:
- # Update entities and/or relationships with decorator(s).
- api_instance.update_decorator(accept, contentType, decorator)
+ # 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 DecoratorsApi->updateDecorator: %s\n" % e)
+ print("Exception when calling EntitiesAndRelationshipsApi->getRelationshipsByType: %s\n" % e)
-
- extern crate DecoratorsApi;
+
+ extern crate EntitiesAndRelationshipsApi;
pub fn main() {
let accept = application/json; // String
- let contentType = application/json; // String
- let decorator = ; // Decorator
+ 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 = DecoratorsApi::Context::default();
- let result = client.updateDecorator(accept, contentType, decorator, &context).wait();
+ let mut context = EntitiesAndRelationshipsApi::Context::default();
+ let result = client.getRelationshipsByType(accept, domainName, relationshipTypeName, targetFilter, scopeFilter, offset, limit, &context).wait();
println!("{:?}", result);
}
@@ -6759,24 +7021,26 @@ pub fn main() {
Parameters
-
- Header parameters
+ Path parameters
-
- Name
- Description
-
- Accept*
+
+ Name
+ Description
+
+ domainName*
-
+
String
+
+domain name
+
Required
@@ -6786,11 +7050,11 @@ pub fn main() {
- Content-Type*
+ relationshipTypeName*
-
+
@@ -6808,55 +7072,29 @@ pub fn main() {
- Body parameters
+ Header parameters
Name
Description
- decorator *
+ Accept*
-
-
-
+
+
+
+
+ String
+
+
+
+
+ Required
+
+
+
@@ -6864,35 +7102,139 @@ $(document).ready(function() {
+ 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
-
-
+
+
-