<html>
<head>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
- <title>Topology and Inventory API</title>
+ <title>Topology Exposure and Inventory API</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta charset="UTF-8" />
"type" : "string",
"enum" : [ "merge", "delete" ]
},
- "classifier" : {
+ "classifiers" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
-};
- defs["Collection"] = {
- "type" : "object",
- "properties" : {
- "collectionName" : {
- "type" : "string"
- },
- "criteria" : {
- "$ref" : "#/components/schemas/TopologySelection"
- }
- }
-};
- defs["CollectionResponse"] = {
- "type" : "object",
- "properties" : {
- "id" : {
- "type" : "string"
- },
- "collectionName" : {
- "type" : "string"
- },
- "criteria" : {
- "$ref" : "#/components/schemas/CollectionResponse_criteria"
- }
- }
-};
- defs["CollectionResponse_criteria"] = {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/StaticSelection"
- }, {
- "$ref" : "#/components/schemas/DynamicSelection"
- } ]
-};
- defs["Collections"] = {
- "title" : "Collections",
- "type" : "object",
- "properties" : {
- "items" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/CollectionResponse"
- }
- },
- "self" : {
- "$ref" : "#/components/schemas/Href"
- },
- "first" : {
- "$ref" : "#/components/schemas/Href"
- },
- "prev" : {
- "$ref" : "#/components/schemas/Href"
- },
- "next" : {
- "$ref" : "#/components/schemas/Href"
- },
- "last" : {
- "$ref" : "#/components/schemas/Href"
- },
- "totalCount" : {
- "type" : "integer"
- }
- }
};
defs["Decorator"] = {
"title" : "Decorator",
},
"decorators" : {
"type" : "object",
- "additionalProperties" : {
- "type" : "string"
- }
+ "additionalProperties" : true,
+ "description" : "Decorators must be defined in schema before use. Data type of a decorator is restricted as defined by it's schema."
},
"entityIds" : {
"type" : "array",
}
}
};
- defs["Href"] = {
- "title" : "Href",
+ defs["Group"] = {
"type" : "object",
"properties" : {
- "href" : {
- "type" : "string",
- "format" : "uri-template"
+ "groupName" : {
+ "type" : "string"
+ },
+ "criteria" : {
+ "$ref" : "#/components/schemas/TopologySelection"
}
}
};
- defs["QueryMessage"] = {
- "title" : "Query",
+ defs["GroupResponse"] = {
"type" : "object",
"properties" : {
- "query" : {
+ "id" : {
+ "type" : "string"
+ },
+ "groupName" : {
"type" : "string"
+ },
+ "criteria" : {
+ "$ref" : "#/components/schemas/GroupResponse_criteria"
+ }
+ }
+};
+ defs["GroupResponse_criteria"] = {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/StaticSelection"
+ }, {
+ "$ref" : "#/components/schemas/DynamicSelection"
+ } ]
+};
+ defs["Groups"] = {
+ "title" : "Groups",
+ "type" : "object",
+ "properties" : {
+ "items" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/GroupResponse"
+ }
+ },
+ "self" : {
+ "$ref" : "#/components/schemas/Href"
+ },
+ "first" : {
+ "$ref" : "#/components/schemas/Href"
+ },
+ "prev" : {
+ "$ref" : "#/components/schemas/Href"
+ },
+ "next" : {
+ "$ref" : "#/components/schemas/Href"
+ },
+ "last" : {
+ "$ref" : "#/components/schemas/Href"
+ },
+ "totalCount" : {
+ "type" : "integer"
+ }
+ }
+};
+ defs["Href"] = {
+ "title" : "Href",
+ "type" : "object",
+ "properties" : {
+ "href" : {
+ "type" : "string",
+ "format" : "uri-template"
}
}
};
"type" : "string"
},
"domain" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
+ "type" : "string"
},
"revision" : {
"type" : "string"
<li data-group="Classifiers" data-name="updateClassifier" class="">
<a href="#api-Classifiers-updateClassifier">updateClassifier</a>
</li>
- <li class="nav-header" data-group="Collections"><a href="#api-Collections">API Methods - Collections</a></li>
- <li data-group="Collections" data-name="createCollection" class="">
- <a href="#api-Collections-createCollection">createCollection</a>
- </li>
- <li data-group="Collections" data-name="deleteCollection" class="">
- <a href="#api-Collections-deleteCollection">deleteCollection</a>
- </li>
- <li data-group="Collections" data-name="getAllCollections" class="">
- <a href="#api-Collections-getAllCollections">getAllCollections</a>
- </li>
- <li data-group="Collections" data-name="getCollection" class="">
- <a href="#api-Collections-getCollection">getCollection</a>
- </li>
- <li data-group="Collections" data-name="updateCollection" class="">
- <a href="#api-Collections-updateCollection">updateCollection</a>
- </li>
<li class="nav-header" data-group="Decorators"><a href="#api-Decorators">API Methods - Decorators</a></li>
<li data-group="Decorators" data-name="updateDecorator" class="">
<a href="#api-Decorators-updateDecorator">updateDecorator</a>
<li data-group="EntitiesAndRelationships" data-name="getTopologyRelationshipTypes" class="">
<a href="#api-EntitiesAndRelationships-getTopologyRelationshipTypes">getTopologyRelationshipTypes</a>
</li>
- <li class="nav-header" data-group="GeoQuery"><a href="#api-GeoQuery">API Methods - GeoQuery</a></li>
- <li data-group="GeoQuery" data-name="geoQueryTopologyAcrossDomains" class="">
- <a href="#api-GeoQuery-geoQueryTopologyAcrossDomains">geoQueryTopologyAcrossDomains</a>
- </li>
<li class="nav-header" data-group="Schemas"><a href="#api-Schemas">API Methods - Schemas</a></li>
<li data-group="Schemas" data-name="createSchema" class="">
<a href="#api-Schemas-createSchema">createSchema</a>
<li data-group="Schemas" data-name="getSchemas" class="">
<a href="#api-Schemas-getSchemas">getSchemas</a>
</li>
+ <li class="nav-header" data-group="TopologyGroups"><a href="#api-TopologyGroups">API Methods - TopologyGroups</a></li>
+ <li data-group="TopologyGroups" data-name="createGroup" class="">
+ <a href="#api-TopologyGroups-createGroup">createGroup</a>
+ </li>
+ <li data-group="TopologyGroups" data-name="deleteGroup" class="">
+ <a href="#api-TopologyGroups-deleteGroup">deleteGroup</a>
+ </li>
+ <li data-group="TopologyGroups" data-name="getAllGroups" class="">
+ <a href="#api-TopologyGroups-getAllGroups">getAllGroups</a>
+ </li>
+ <li data-group="TopologyGroups" data-name="getGroup" class="">
+ <a href="#api-TopologyGroups-getGroup">getGroup</a>
+ </li>
+ <li data-group="TopologyGroups" data-name="updateGroup" class="">
+ <a href="#api-TopologyGroups-updateGroup">updateGroup</a>
+ </li>
</ul>
</nav>
</div>
<div id="content">
<div id="project">
<div class="pull-left">
- <h1>Topology and Inventory API</h1>
+ <h1>Topology Exposure and Inventory API</h1>
</div>
<div class="clearfix"></div>
</div>
<div class="app-desc">Version: 0.11.0</div>
<hr>
<div id="app-description" class="app-desc">
- <p>Topology and Inventory data is the information that represents entities in a telecommunications network and the relationships between them that provide insight into a particular aspect of the network of importance to specific use cases. Topology and Inventory data can be derived from inventory, configuration, or other data.</p>
-<p>Topology and Inventory supports several topology domains. A domain is a grouping of network topology entities which handles topology data.</p>
-<p>Entities are enabling the modelling and storage of complex network infrastructure and relationships.</p>
-<p>Relationships are a uni-directional connection between two entities, one of which is the originating side (A-side) and the other is the terminating side (B-side). The order of the sides matters since it defines the relationship itself which must be unique</p>
-<p>Topology and Inventory API provides the capabilities to fetch topology data. Using the filtering options, it is possible to define more specific query requests.</p>
+ <p>Topology Exposure and Inventory data is the information that represents entities
+in a telecommunications network and the relationships between them that
+provide insight into a particular aspect of the network of importance to
+specific use cases. Topology and Inventory data can be derived from
+inventory, configuration, or other data.</p>
+<p>Topology Exposure and Inventory supports several topology domains. A domain is a
+grouping of topology and inventory entities that handles topology and
+inventory data.</p>
+<p>Entities are enabling the modelling and storage of complex network
+infrastructure and relationships.</p>
+<p>A relationship is a bi-directional connection between two entities, one
+of which is the originating side (A-side) and the other is the
+terminating side (B-side). The order of the sides matters since it
+defines the relationship itself which must be unique.</p>
+<p>Classifier (also known as tag or label) permits the association of a
+well defined user specified string with an entity or relationship.</p>
+<p>Decorators are user-defined attributes (key-value pairs) which can
+be applied to topology entities and relationships.</p>
+<p>Topology Exposure and Inventory API provides the capabilities to fetch topology
+data. Using the filtering options, it is possible to define more specific
+query requests.</p>
<h2>Querying simple entities</h2>
-<p>EntityType is used as the root of the queries (from here referred as RootObject). Every other object, either <em>targetFilter</em> or <em>scopeFilter</em>, has to relate to the RootObject. The queries are constructed starting from the RootObject and all other objects are joined to it. If there is no connection between the RootObject and the other object(s), the query will not get constructed. The RootObject still can be retrieved and filtered using the <em>/attributes</em>.</p>
-<p>| USE CASE | ENTITY TYPE | TARGET FILTER | SCOPE FILTER | QUERY RESULT |
-|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------|:----------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------|
-| To return the ids for all instances of the entityType used in the query. | GNBDUFunction | | | All ids of every GNBDUFunction |
-| To return all attributes of every instance of the entityType used in the query. | GNBDUFunction | /attributes | | All GNBDUFunctions with every attribute |
-| To return every instance of the entityType used in the query, but only the attribute that was defined in the <em>targetFilter</em> parameter. <br/> Note: The attribute must be a valid field of the object. | GNBDUFunction | /attributes(gNBId) <br/> <strong>OR</strong> <br/> /attributes/gNBId | | All FDNs of every GNBDUFunction |
-| To return every instance of the entityType used in the query, but only the attributes that were defined in the <em>targetFilter</em> parameter. <br/> Case 1: The attributes must be separated by a comma "," in case of using parenthesis "()". <br/> Case 2: The attributes must be separated by a semicolon ";" in case of using slash "/". <br/> Note: The attributes must be valid <em>targetFilter</em> of the object. | GNBDUFunction | /attributes(gNBId, gNBIdLength) <br/> <strong>OR</strong> <br/> /attributes/gNBId; /attributes/gNBIdLength | | All Ids and FDNs of every GNBDUFunction |
-| To return the ids for all instances of the entityType used in the query, that matches the given attribute in the <em>scopeFilter</em> parameter. <br/> Note: The attribute must be a valid field of the object. | GNBDUFunction | | /attributes[contains (@fdn, "/SubNetwork=Ireland/")] | Unique set of ids of GNBDUFunctions, where fdn contains "SubNetwork=Ireland" |
-| To return the ids for all instances of the entityType used in the query, that matches the given attributes in the <em>scopeFilter</em> parameter. <br/> Note: the entityType and the object in the <em>scopeFilter</em> parameter must match, and the attributes must be valid field or fields of the object. The attributes must be separated by a comma ",". | GNBDUFunction | | /attributes[@gNBIdLength=3 and @gNBId=111] | Unique set of ids of GNBDUFunctions, where the gNBIdLength equals 3 and the gNBId equals 111 |
-| To return the ids for all instances of the entityType used in the query, that satisfies every condition in one of the tags in the <em>scopeFilter</em> parameter. A tag is a complete unit of <em>scopeFilter</em> parameter surrounded by square brackets. <br/> Note: The attributes must be valid field or fields of the object. | GNBDUFunction | | /attributes[@gNBIdLength=3 and @gNBId=111] <br/> <strong>OR</strong> <br/> /attributes[@gNBIdLength=3 and @gNBId=112] | Unique set of ids of GNBDUFunctions, where where the gNBIdLength equals 3 and the gNBId is either 111 or 112 |</p>
+<p>The <em>entityTypeName</em> is used as the root of the queries (from here
+referred to as RootObject). Every other object, either in <em>targetFilter</em> or
+<em>scopeFilter</em>, has to relate to the RootObject. The queries are
+constructed starting from the RootObject and all other objects are joined
+to it. If there is no connection between the RootObject and the other
+object(s), the query is not constructed. The RootObject still can be
+retrieved and filtered using the <em>/attributes</em>.</p>
+<p>| Use case | domainName | entityTypeName | targetFilter | scopeFilter | Query result |
+|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|:---------------|:--------------------------------|:----------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------|
+| To return the ids for all instances of the entityTypeName used in the query. | RAN | GNBDUFunction | | | All ids of every GNBDUFunction |
+| To return all attributes of every instance of the entityTypeName used in the query. | RAN | GNBDUFunction | /attributes | | All GNBDUFunctions with every attribute |
+| To return every instance of the entityTypeName used in the query, but only the attribute that was defined in the <em>targetFilter</em> parameter. <br/> Note: The attribute must be a valid field of the object. | RAN | GNBDUFunction | /attributes(gNBId) | | All gNBIds of every GNBDUFunction |
+| To return every instance of the entityTypeName used in the query, but only the attributes that were defined in the <em>targetFilter</em> parameter. <br/> Note: The attributes must be separated by a comma "," when using parenthesis "()". | RAN | GNBDUFunction | /attributes(gNBId, gNBIdLength) | | All gNBIds and gNBIdLengths of every GNBDUFunction |
+| To return the ids for all instances of the entityTypeName used in the query, that matches the given property in the <em>scopeFilter</em> parameter. | RAN | GNBDUFunction | | /sourceIds[contains (@item, 'SubNetwork=Ireland')] | Unique set of ids of GNBDUFunctions, where sourceIds contains <em>SubNetwork=Ireland</em> |
+| To return the ids for all instances of the entityTypeName used in the query, that matches the given attributes in the <em>scopeFilter</em> parameter. <br/> Note: The attributes must be separated by a <em>AND</em> or <em>OR</em>". | RAN | GNBDUFunction | | /attributes [@gNBIdLength=3 and @gNBId=111] | Unique set of ids of GNBDUFunctions, where the gNBIdLength equals 3 and the gNBId equals 111 |
+| To return the ids for all instances of the entityTypeName used in the query, that satisfies one of the conditions in the <em>scopeFilter</em> parameter. A condition is a complete unit of <em>scopeFilter</em> parameter surrounded by square brackets. <br/> Note: Multiple conditions can be given in the scopeFilter separated by a semicolon ";" to represent AND, or a pipe symbol "|" to represent OR. | RAN | GNBDUFunction | | /attributes [@gNBIdLength=3] | /sourceIds[contains (@item, 'SubNetwork=Ireland')] | Unique set of ids of GNBDUFunctions, where the gNBIdLength equals 3 or the sourceIds contains an item with "SubNetwork=Ireland" |</p>
<h2>Querying connected entities</h2>
-<p>It is possible to get information about directly connected objects as well. If entityType is present in the <em>targetFilter</em> parameter, the query provides information about that entityType itself.</p>
-<p>| USE CASE | ENTITY TYPE | TARGET FILTER | SCOPE FILTER | QUERY RESULT |
-|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|-------------------------------------|-----------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|
-| To return the ids for all instances of the entityType in the <em>targetFilter</em> parameter, if they are directly related to the queried entityType. | GNBDUFunction | /NRCellDU | | Unique set of ids of NRCellDUs that relates to GNBDUFunctions directly with any relationship type |
-| To return the ids for all instances of the entityTypes in the <em>targetFilter</em> parameter, if they are directly related to the entityType. | GNBDUFunction | /NRCellDU ; /NRSectorCarrier | | Unique set of ids of NRCellDUs and NRSectorCarriers that relates to GNBDUFunctions directly with any relationship type |
-| To return the ids for all instances of the queried entityType that has one or more direct relationships with the entityType specified in the <em>scopeFilter</em> parameter. | GNBDUFunction | | /AntennaCapability | Unique set of ids of GNBDUFunctions that are directly related to AntennaCapability with any relationship type |
-| To return the ids for all instances of the queried entityType that has one or more direct relationships with at least one of the entityTypes specified in the <em>scopeFilter</em> parameter. | GNBDUFunction | | /AntennaCapability <br/> <strong>OR</strong> <br/> /NRCellDU | Unique set of ids of GNBDUFunctions that are directly related to AntennaCapability or NRCellDU with any relationship type |</p>
+<p>The <em>entityTypeName</em> is used as the root of the queries.</p>
+<p>| Use case | domainName | entityTypeName | targetFilter | scopeFilter | Query result |
+|:-----------------------------------------------------------------------------------------------------------------------------------------------|-------------|:---------------|:-------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| To return the ids for all instances of an entityTypeName related by an association. | REL_OAM_RAN | ENodeBFunction | | /managed-by-managedElement | All ENodeBFunction entities that are managed by any Managed Element. |
+| To return the ids for all instances of an entityTypeName related by an association to another entity specified by its <em>id</em>. | REL_OAM_RAN | ENodeBFunction | | /managed-by-managedElement [@id = 'urn:3gpp:dn: ManagedElement=1'] | All ENodeBFunction entities that are managed by by the Managed Element <em>urn:3gpp:dn: ManagedElement=1</em>. |
+| To return the attributes for all instances of an entityTypeName related by one or more associations to other entities specified by their <em>id</em>. | REL_OAM_RAN | ENodeBFunction | /attributes | /attributes [@enbId=1] ; /managed-by-managedElement [@id='urn:3gpp:dn: ManagedElement=1'] | /managed-by-managedElement [@id='urn:3gpp:dn: ManagedElement=2'] ; /provided-euTranCell [@id='urn:3gpp:dn: ManagedElement=1, EUtranCell=2'] | All EnodeBFunction entities with enbId as <em>1</em>, managed by the Managed Element <em>urn:3gpp:dn: ManagedElement=1</em> or <em>urn:3gpp:dn: ManagedElement=2</em>, and provides EuTranCell <em>urn:3gpp:dn: ManagedElement=1, EUtranCell=2</em>. |</p>
+<h2>Querying entities for relationships</h2>
+<p>The <em>entityTypeName</em> is used as the root of the queries.</p>
+<p>| Use case | domainName | entityTypeName | entityId | targetFilter | scopeFilter | Query result |
+|:-------------------------------------------------------------------------------------------------------------------|-------------|:---------------|------------------------------------------------|:----------------------------------------|:-------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| To return the relationships for a given entity specified by its id. | RAN | GNBDUFunction | urn:3gpp:dn: ManagedElement=1, GNBDUFunction=1 | | | All relations for the GNBDUFunction with id <em>urn:3gpp:dn: ManagedElement=1, GNBDUFunction=1</em>. |
+| To return specific relationships for a given entity specified by its id. | REL_OAM_RAN | GNBDUFunction | urn:3gpp:dn: ManagedElement=1, GNBDUFunction=1 | /MANAGEDELEMENT _MANAGES _GNBDUFUNCTION | | All <em>MANAGEDELEMENT _MANAGES _GNBDUFUNCTION</em> relations for the GNBDUFunction with id <em>urn:3gpp:dn: ManagedElement=1, GNBDUFunction=1</em>. |
+| To return specific relationships for an entity specified by its id to another entity using its id and association. | REL_OAM_RAN | GNBDUFunction | urn:3gpp:dn: ManagedElement=1, GNBDUFunction=1 | | /managed-by-managedElement [@id = 'urn:3gpp:dn: ManagedElement=1'] | All <em>MANAGEDELEMENT _MANAGES _GNBDUFUNCTION</em> relations for the GNBDUFunction with id <em>urn:3gpp:dn: ManagedElement=1, GNBDUFunction=1</em> where the managed element is <em>urn:3gpp:dn: ManagedElement=1</em>. |</p>
+<h2>Querying on relationships</h2>
+<p>Here, the <em>relationshipTypeName</em> is used as the root of the queries.</p>
+<p>| Use case | domainName | relationshipTypeName | targetFilter | scopeFilter | Query result |
+|:---------------------------------------------------------------------------------------------------------|-------------|:----------------------------------------|:-------------|:-----------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| To return all relationships for a specified relationship type. | REL_OAM_RAN | MANAGEDELEMENT _MANAGES _ENODEBFUNCTION | | | All MANAGEDELEMENT_MANAGES_ENODEBFUNCTION relationships. |
+| To return all relationships for a specified relationship type with a specified association to an entity. | REL_OAM_RAN | MANAGEDELEMENT _MANAGES _ENODEBFUNCTION | | /managed-by-managedElement [@id='urn:3gpp:dn: ManagedElement=1'] | All MANAGEDELEMENT_MANAGES_ENODEBFUNCTION relationships having an association <em>managed-by-managedElement</em> to ManagedElement <em>urn:3gpp:dn: ManagedElement=1</em>. |</p>
+<h2>Querying on classifiers and decorators</h2>
+<p>The <em>domainName</em> is used as the root of the queries.</p>
+<p>| Use case | domainName | targetFilter | scopeFilter | Query result |
+|:--------------------------------------------------------------------------------------------------------------------------------------------------|------------|--------------|:----------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------|
+| Return all related entity IDs that are exactly matched with the specified classifier with given domain name. | RAN | | /classifiers[@item = 'gnbdu-function-model:Indoor'] | All the entity IDs that are classified with "gnbdu-function-model:Indoor" in RAN domain. |
+| Return all related entity IDs that are partially matched for the given classifier with given domain name. | RAN | | /classifiers[contains(@item, 'Ind')] | All the entity IDs that are partially matched with "Ind" in RAN domain. |
+| Return all related entity IDs that are exactly matched with the key-value pair that specified decorators with given domain name. | RAN | | /decorators[@gnbdu-function-model:textdata = 'Stockholm'] | All the entity IDs that are exactly matched with "gnbdu-function-model:textdata = 'Stockholm'" in RAN domain. |
+| Return all related entity IDs that are exactly matched with key parameter where the value of the decorator is unknown with given domain name. | RAN | | /decorators[contains(@gnbdu-function-model:textdata, "")] | All the entity IDs that are exactly matched with "gnbdu-function-model:textdata as key of the decorator in RAN domain. |</p>
+<p>The <em>entityName</em> is used as the root of the queries.</p>
+<p>| Use case | entityName | relationshipTypeName | targetFilter | scopeFilter | Query result |
+|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|:---------------------|:--------------------------|:----------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Return all related entity IDs and classifiers. | NRCellDU | | /classifiers | | All NRCellDU IDs and classifiers. |
+| Return all related entity IDs and decorators. | NRCellDU | | /decorators | | All NRCellDU IDs and decorators. |
+| Return all related entity IDs that are exact match for the given classifiers and decorators. | NRCellDU | | | /classifiers[@item = 'gnbdu-function-model:Indoor']; /decorators [@gnbdu-function-model:textdata = 'Stockholm'] | All NRCellDU IDs where key of the decorator is "gnbdu-function-model:textdata" and the value of the decorator is 'Stockholm'" and where classifier exactly contains "gnbdu-function-model:Indoor". |
+| Return all related entity IDs and classifiers that are partially matched for the given classifier. | NRCellDU | | /classifiers | /classifiers[contains(@item, 'Ind')] | All NRCellDU IDs and classifiers partially contains the text "Ind". |
+| Return all related entity IDs and decorators where key is a exact match and value is partially match. | NRCellDU | | /decorators | /decorators[contains(@gnbdu-function-model:textdata, 'Stoc')] | All NRCellDU IDs and where key of the decorator is "gnbdu-function-model:textdata" and the value of the decorator partially contains 'Stoc'. |
+| Return all related entity IDs, decorators and classifiers where key of the decorator is a exact match and value partially matches, and classifiers partially contains from the given parameters. | NRCellDU | | /classifiers; /decorators | /classifiers[contains(@item, 'Ind')]; /decorators[contains(@gnbdu-function-model:textdata, 'Stoc')] | All NRCellDU IDs and decorators where key of the decorator is "gnbdu-function-model:textdata" and the value of the decorator partially contains 'Stoc' and classifiers partially contains the text "Ind". |</p>
+<p>The <em>relationshipTypeName</em> is used as the root of the queries.</p>
+<p>| Use case | entityName | relationshipTypeName | targetFilter | scopeFilter | Query result |
+|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|:----------------------------------------|:--------------------------|:----------------------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Return all related relationships IDs and classifiers. | | MANAGEDELEMENT _MANAGES _ENODEBFUNCTION | /classifiers | | All MANAGEDELEMENT _MANAGES _ENODEBFUNCTION IDs and classifiers. |
+| Return all related relationships IDs and decorators. | | MANAGEDELEMENT _MANAGES _ENODEBFUNCTION | /decorators | | All MANAGEDELEMENT _MANAGES _ENODEBFUNCTION IDs and decorators. |
+| Return all related relationship IDs that are exact match for the given classifier and decorators. | | MANAGEDELEMENT _MANAGES _ENODEBFUNCTION | | /classifiers[@item = 'gnbdu-function-model:Indoor']; /decorators [@gnbdu-function-model:textdata = 'Stockholm'] | All MANAGEDELEMENT _MANAGES _ENODEBFUNCTION IDs and decorators where key of the decorator is "gnbdu-function-model:textdata" and the value of the decorator is 'Stockholm'" and classifiers exactly contains "gnbdu-function-model:Indoor". |
+| Return all related relationships IDs and classifiers that are partially matched for the given classifier. | | MANAGEDELEMENT _MANAGES _ENODEBFUNCTION | /classifiers | /classifiers[contains(@item, 'Ind')] | All MANAGEDELEMENT _MANAGES _ENODEBFUNCTION and classifiers partially contains the text "Ind". |
+| Return all related relationships IDs and decorators where key is a exact match and value is partially match. | | MANAGEDELEMENT _MANAGES _ENODEBFUNCTION | /decorators | /decorators[contains(@gnbdu-function-model:textdata, 'Stock')] | All MANAGEDELEMENT _MANAGES _ENODEBFUNCTION and where key of the decorator is "gnbdu-function-model:textdata" and the value of the decorator partially contains 'Stock'. |
+| Return all related relationships IDs,decorators and classifiers where key of the decorator is a exact match and value partially matches, and classifiers partially contains from the given parameters. | | MANAGEDELEMENT _MANAGES _ENODEBFUNCTION | /classifiers; /decorators | /classifiers[contains(@item, 'Ind')]; /decorators[contains(@gnbdu-function-model:textdata, 'Stock')] | All MANAGEDELEMENT _MANAGES _ENODEBFUNCTION IDs and decorators where key of the decorator is "gnbdu-function-model:textdata" and the value of the decorator partially contains 'Stock' and classifiers partially contains the text "Ind". |</p>
</div>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Update entities and/or relationships with classifier(s).</p>
+ <p class="marked">Update entities and/or relationships with classifier(s). The sum of the given entityIds and relationshipIds cannot exceed 100 by default.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/classifiers</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/classifiers</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<div class="tab-content">
<div class="tab-pane active" id="examples-Classifiers-updateClassifier-0-curl">
- <pre class="prettyprint"><code class="language-bsh">curl -X PUT \
+ <pre class="prettyprint"><code class="language-bsh">curl -X POST \
-H "Accept: application/problem+json" \
-H "Content-Type: application/json" \
"https://localhost/topology-inventory/v1alpha11/classifiers" \
-d '{
- "classifier" : [ "classifier", "classifier" ],
+ "classifiers" : [ "classifiers", "classifiers" ],
"relationshipIds" : [ "relationshipIds", "relationshipIds" ],
"operation" : "merge",
"entityIds" : [ "entityIds", "entityIds" ]
</div>
<div class="tab-pane" id="examples-Classifiers-updateClassifier-0-javascript">
- <pre class="prettyprint"><code class="language-js">var TopologyAndInventoryApi = require('topology_and_inventory_api');
+ <pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
-var api = new TopologyAndInventoryApi.ClassifiersApi()
+var api = new TopologyExposureAndInventoryApi.ClassifiersApi()
var accept = application/json; // {String}
var contentType = application/json; // {String}
var classifier = ; // {Classifier}
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
- "status" : "409'",
+ "status" : "409",
"title" : "Conflicting request",
"details" : "The request cannot be processed as the resource is in use."
}
</div>
<hr>
</section>
- <section id="api-Collections">
- <h1>Collections</h1>
- <div id="api-Collections-createCollection">
- <article id="api-Collections-createCollection-0" data-group="User" data-name="createCollection" data-version="0">
+ <section id="api-Decorators">
+ <h1>Decorators</h1>
+ <div id="api-Decorators-updateDecorator">
+ <article id="api-Decorators-updateDecorator-0" data-group="User" data-name="updateDecorator" data-version="0">
<div class="pull-left">
- <h1>createCollection</h1>
- <p>Create a collection.</p>
+ <h1>updateDecorator</h1>
+ <p>Update entities and/or relationships with decorator(s).</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Create a collection.</p>
+ <p class="marked">Update entities and/or relationships with decorator(s). The sum of the given entityIds and relationshipIds cannot exceed 100 by default.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/collections</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/decorators</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
- <li class="active"><a href="#examples-Collections-createCollection-0-curl">Curl</a></li>
- <li class=""><a href="#examples-Collections-createCollection-0-java">Java</a></li>
- <li class=""><a href="#examples-Collections-createCollection-0-dart">Dart</a></li>
- <li class=""><a href="#examples-Collections-createCollection-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-Collections-createCollection-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-Collections-createCollection-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-Collections-createCollection-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-Collections-createCollection-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-Collections-createCollection-0-csharp">C#</a></li>
- <li class=""><a href="#examples-Collections-createCollection-0-php">PHP</a></li>
- <li class=""><a href="#examples-Collections-createCollection-0-perl">Perl</a></li>
- <li class=""><a href="#examples-Collections-createCollection-0-python">Python</a></li>
- <li class=""><a href="#examples-Collections-createCollection-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-Decorators-updateDecorator-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-Decorators-updateDecorator-0-java">Java</a></li>
+ <li class=""><a href="#examples-Decorators-updateDecorator-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-Decorators-updateDecorator-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-Decorators-updateDecorator-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-Decorators-updateDecorator-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-Decorators-updateDecorator-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-Decorators-updateDecorator-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-Decorators-updateDecorator-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-Decorators-updateDecorator-0-php">PHP</a></li>
+ <li class=""><a href="#examples-Decorators-updateDecorator-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-Decorators-updateDecorator-0-python">Python</a></li>
+ <li class=""><a href="#examples-Decorators-updateDecorator-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-Collections-createCollection-0-curl">
+ <div class="tab-pane active" id="examples-Decorators-updateDecorator-0-curl">
<pre class="prettyprint"><code class="language-bsh">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" ]
}'
</code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-createCollection-0-java">
+ <div class="tab-pane" id="examples-Decorators-updateDecorator-0-java">
<pre class="prettyprint"><code class="language-java">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();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-createCollection-0-dart">
+ <div class="tab-pane" id="examples-Decorators-updateDecorator-0-dart">
<pre class="prettyprint"><code class="language-dart">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');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-createCollection-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.CollectionsApi;
+ <div class="tab-pane" id="examples-Decorators-updateDecorator-0-android">
+ <pre class="prettyprint"><code class="language-java">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();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-Collections-createCollection-0-groovy">
+ <div class="tab-pane" id="examples-Decorators-updateDecorator-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-Collections-createCollection-0-objc">
+ <div class="tab-pane" id="examples-Decorators-updateDecorator-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// 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);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-createCollection-0-javascript">
- <pre class="prettyprint"><code class="language-js">var TopologyAndInventoryApi = require('topology_and_inventory_api');
+ <div class="tab-pane" id="examples-Decorators-updateDecorator-0-javascript">
+ <pre class="prettyprint"><code class="language-js">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);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-Collections-createCollection-0-angular">
+ <!--<div class="tab-pane" id="examples-Decorators-updateDecorator-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-Collections-createCollection-0-csharp">
+ <div class="tab-pane" id="examples-Decorators-updateDecorator-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
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 );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-createCollection-0-php">
+ <div class="tab-pane" id="examples-Decorators-updateDecorator-0-php">
<pre class="prettyprint"><code class="language-php"><?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;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-createCollection-0-perl">
+ <div class="tab-pane" id="examples-Decorators-updateDecorator-0-perl">
<pre class="prettyprint"><code class="language-perl">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";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-createCollection-0-python">
+ <div class="tab-pane" id="examples-Decorators-updateDecorator-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import openapi_client
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)</code></pre>
+ print("Exception when calling DecoratorsApi->updateDecorator: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-createCollection-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate CollectionsApi;
+ <div class="tab-pane" id="examples-Decorators-updateDecorator-0-rust">
+ <pre class="prettyprint"><code class="language-rust">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);
}
<td>
- <div id="d2e199_createCollection_accept">
+ <div id="d2e199_updateDecorator_accept">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
<td>
- <div id="d2e199_createCollection_contentType">
+ <div id="d2e199_updateDecorator_contentType">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
<th width="150px">Name</th>
<th>Description</th>
</tr>
- <tr><td style="width:150px;">collection <span style="color:red;">*</span></td>
+ <tr><td style="width:150px;">decorator <span style="color:red;">*</span></td>
<td>
<p class="marked"></p>
<script>
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/Collection"
+ "$ref" : "#/components/schemas/Decorator"
},
"examples" : {
- "dynamicCollection" : {
- "$ref" : "#/components/examples/DynamicCollectionExample"
- },
- "staticCollection" : {
- "$ref" : "#/components/examples/StaticCollectionExample"
+ "decorator" : {
+ "$ref" : "#/components/examples/DecoratorExample"
}
}
}
}
var view = new JSONSchemaView(schema,2,{isBodyParam: true});
- var result = $('#d2e199_createCollection_collection');
+ var result = $('#d2e199_updateDecorator_decorator');
result.empty();
result.append(view.render());
});
</script>
-<div id="d2e199_createCollection_collection"></div>
+<div id="d2e199_updateDecorator_decorator"></div>
</td>
</tr>
<h2>Responses</h2>
- <h3 id="examples-Collections-createCollection-title-201"></h3>
- <p id="examples-Collections-createCollection-description-201" class="marked"></p>
+ <h3 id="examples-Decorators-updateDecorator-title-204"></h3>
+ <p id="examples-Decorators-updateDecorator-description-204" class="marked"></p>
<script>
- var responseCollections201_description = `Created`;
- var responseCollections201_description_break = responseCollections201_description.indexOf('\n');
- if (responseCollections201_description_break == -1) {
- $("#examples-Collections-createCollection-title-201").text("Status: 201 - " + responseCollections201_description);
+ var responseDecorators204_description = `No Content`;
+ var responseDecorators204_description_break = responseDecorators204_description.indexOf('\n');
+ if (responseDecorators204_description_break == -1) {
+ $("#examples-Decorators-updateDecorator-title-204").text("Status: 204 - " + responseDecorators204_description);
} else {
- $("#examples-Collections-createCollection-title-201").text("Status: 201 - " + responseCollections201_description.substring(0, responseCollections201_description_break));
- $("#examples-Collections-createCollection-description-201").html(responseCollections201_description.substring(responseCollections201_description_break));
+ $("#examples-Decorators-updateDecorator-title-204").text("Status: 204 - " + responseDecorators204_description.substring(0, responseDecorators204_description_break));
+ $("#examples-Decorators-updateDecorator-description-204").html(responseDecorators204_description.substring(responseDecorators204_description_break));
}
</script>
- <ul id="responses-detail-Collections-createCollection-201" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-Collections-createCollection-201-schema">Schema</a>
- </li>
-
-
+ <ul id="responses-detail-Decorators-updateDecorator-204" class="nav nav-tabs nav-tabs-examples" >
</ul>
- <div class="tab-content" id="responses-Collections-createCollection-201-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Collections-createCollection-201-schema">
- <div id="responses-Collections-createCollection-schema-201" class="exampleStyle">
+ <div class="tab-content" id="responses-Decorators-updateDecorator-204-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Decorators-updateDecorator-204-schema">
+ <div id="responses-Decorators-updateDecorator-schema-204" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Created",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/CollectionResponse"
- },
- "examples" : {
- "collection" : {
- "$ref" : "#/components/examples/CollectionResponseExample"
- }
- }
- }
- }
+ "description" : "No Content",
+ "content" : { }
};
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Collections-createCollection-201-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Collections-createCollection-schema-201');
+ $('#responses-Decorators-updateDecorator-204-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Decorators-updateDecorator-schema-204');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Collections-createCollection-201-schema-data' type='hidden' value=''></input>
+ <input id='responses-Decorators-updateDecorator-204-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Collections-createCollection-title-400"></h3>
- <p id="examples-Collections-createCollection-description-400" class="marked"></p>
+ <h3 id="examples-Decorators-updateDecorator-title-400"></h3>
+ <p id="examples-Decorators-updateDecorator-description-400" class="marked"></p>
<script>
- var responseCollections400_description = `Bad Request`;
- var responseCollections400_description_break = responseCollections400_description.indexOf('\n');
- if (responseCollections400_description_break == -1) {
- $("#examples-Collections-createCollection-title-400").text("Status: 400 - " + responseCollections400_description);
+ var responseDecorators400_description = `Bad Request`;
+ var responseDecorators400_description_break = responseDecorators400_description.indexOf('\n');
+ if (responseDecorators400_description_break == -1) {
+ $("#examples-Decorators-updateDecorator-title-400").text("Status: 400 - " + responseDecorators400_description);
} else {
- $("#examples-Collections-createCollection-title-400").text("Status: 400 - " + responseCollections400_description.substring(0, responseCollections400_description_break));
- $("#examples-Collections-createCollection-description-400").html(responseCollections400_description.substring(responseCollections400_description_break));
+ $("#examples-Decorators-updateDecorator-title-400").text("Status: 400 - " + responseDecorators400_description.substring(0, responseDecorators400_description_break));
+ $("#examples-Decorators-updateDecorator-description-400").html(responseDecorators400_description.substring(responseDecorators400_description_break));
}
</script>
- <ul id="responses-detail-Collections-createCollection-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Decorators-updateDecorator-400" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Collections-createCollection-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Decorators-updateDecorator-400-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Collections-createCollection-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Collections-createCollection-400-schema">
- <div id="responses-Collections-createCollection-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-Decorators-updateDecorator-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Decorators-updateDecorator-400-schema">
+ <div id="responses-Decorators-updateDecorator-schema-400" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Collections-createCollection-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Collections-createCollection-schema-400');
+ $('#responses-Decorators-updateDecorator-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Decorators-updateDecorator-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Collections-createCollection-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-Decorators-updateDecorator-400-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Collections-createCollection-title-401"></h3>
- <p id="examples-Collections-createCollection-description-401" class="marked"></p>
+ <h3 id="examples-Decorators-updateDecorator-title-401"></h3>
+ <p id="examples-Decorators-updateDecorator-description-401" class="marked"></p>
<script>
- var responseCollections401_description = `Unauthorized`;
- var responseCollections401_description_break = responseCollections401_description.indexOf('\n');
- if (responseCollections401_description_break == -1) {
- $("#examples-Collections-createCollection-title-401").text("Status: 401 - " + responseCollections401_description);
+ var responseDecorators401_description = `Unauthorized`;
+ var responseDecorators401_description_break = responseDecorators401_description.indexOf('\n');
+ if (responseDecorators401_description_break == -1) {
+ $("#examples-Decorators-updateDecorator-title-401").text("Status: 401 - " + responseDecorators401_description);
} else {
- $("#examples-Collections-createCollection-title-401").text("Status: 401 - " + responseCollections401_description.substring(0, responseCollections401_description_break));
- $("#examples-Collections-createCollection-description-401").html(responseCollections401_description.substring(responseCollections401_description_break));
+ $("#examples-Decorators-updateDecorator-title-401").text("Status: 401 - " + responseDecorators401_description.substring(0, responseDecorators401_description_break));
+ $("#examples-Decorators-updateDecorator-description-401").html(responseDecorators401_description.substring(responseDecorators401_description_break));
}
</script>
- <ul id="responses-detail-Collections-createCollection-401" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Decorators-updateDecorator-401" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Collections-createCollection-401-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Decorators-updateDecorator-401-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Collections-createCollection-401-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Collections-createCollection-401-schema">
- <div id="responses-Collections-createCollection-schema-401" class="exampleStyle">
+ <div class="tab-content" id="responses-Decorators-updateDecorator-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Decorators-updateDecorator-401-schema">
+ <div id="responses-Decorators-updateDecorator-schema-401" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Collections-createCollection-401-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Collections-createCollection-schema-401');
+ $('#responses-Decorators-updateDecorator-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Decorators-updateDecorator-schema-401');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Collections-createCollection-401-schema-data' type='hidden' value=''></input>
+ <input id='responses-Decorators-updateDecorator-401-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Collections-createCollection-title-403"></h3>
- <p id="examples-Collections-createCollection-description-403" class="marked"></p>
+ <h3 id="examples-Decorators-updateDecorator-title-403"></h3>
+ <p id="examples-Decorators-updateDecorator-description-403" class="marked"></p>
<script>
- var responseCollections403_description = `Forbidden`;
- var responseCollections403_description_break = responseCollections403_description.indexOf('\n');
- if (responseCollections403_description_break == -1) {
- $("#examples-Collections-createCollection-title-403").text("Status: 403 - " + responseCollections403_description);
+ var responseDecorators403_description = `Forbidden`;
+ var responseDecorators403_description_break = responseDecorators403_description.indexOf('\n');
+ if (responseDecorators403_description_break == -1) {
+ $("#examples-Decorators-updateDecorator-title-403").text("Status: 403 - " + responseDecorators403_description);
} else {
- $("#examples-Collections-createCollection-title-403").text("Status: 403 - " + responseCollections403_description.substring(0, responseCollections403_description_break));
- $("#examples-Collections-createCollection-description-403").html(responseCollections403_description.substring(responseCollections403_description_break));
+ $("#examples-Decorators-updateDecorator-title-403").text("Status: 403 - " + responseDecorators403_description.substring(0, responseDecorators403_description_break));
+ $("#examples-Decorators-updateDecorator-description-403").html(responseDecorators403_description.substring(responseDecorators403_description_break));
}
</script>
- <ul id="responses-detail-Collections-createCollection-403" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Decorators-updateDecorator-403" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Collections-createCollection-403-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Decorators-updateDecorator-403-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Collections-createCollection-403-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Collections-createCollection-403-schema">
- <div id="responses-Collections-createCollection-schema-403" class="exampleStyle">
+ <div class="tab-content" id="responses-Decorators-updateDecorator-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Decorators-updateDecorator-403-schema">
+ <div id="responses-Decorators-updateDecorator-schema-403" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Collections-createCollection-403-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Collections-createCollection-schema-403');
+ $('#responses-Decorators-updateDecorator-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Decorators-updateDecorator-schema-403');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Collections-createCollection-403-schema-data' type='hidden' value=''></input>
+ <input id='responses-Decorators-updateDecorator-403-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Collections-createCollection-title-409"></h3>
- <p id="examples-Collections-createCollection-description-409" class="marked"></p>
+ <h3 id="examples-Decorators-updateDecorator-title-409"></h3>
+ <p id="examples-Decorators-updateDecorator-description-409" class="marked"></p>
<script>
- var responseCollections409_description = `Conflict`;
- var responseCollections409_description_break = responseCollections409_description.indexOf('\n');
- if (responseCollections409_description_break == -1) {
- $("#examples-Collections-createCollection-title-409").text("Status: 409 - " + responseCollections409_description);
+ var responseDecorators409_description = `Conflict`;
+ var responseDecorators409_description_break = responseDecorators409_description.indexOf('\n');
+ if (responseDecorators409_description_break == -1) {
+ $("#examples-Decorators-updateDecorator-title-409").text("Status: 409 - " + responseDecorators409_description);
} else {
- $("#examples-Collections-createCollection-title-409").text("Status: 409 - " + responseCollections409_description.substring(0, responseCollections409_description_break));
- $("#examples-Collections-createCollection-description-409").html(responseCollections409_description.substring(responseCollections409_description_break));
+ $("#examples-Decorators-updateDecorator-title-409").text("Status: 409 - " + responseDecorators409_description.substring(0, responseDecorators409_description_break));
+ $("#examples-Decorators-updateDecorator-description-409").html(responseDecorators409_description.substring(responseDecorators409_description_break));
}
</script>
- <ul id="responses-detail-Collections-createCollection-409" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Decorators-updateDecorator-409" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Collections-createCollection-409-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Decorators-updateDecorator-409-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Collections-createCollection-409-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Collections-createCollection-409-schema">
- <div id="responses-Collections-createCollection-schema-409" class="exampleStyle">
+ <div class="tab-content" id="responses-Decorators-updateDecorator-409-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Decorators-updateDecorator-409-schema">
+ <div id="responses-Decorators-updateDecorator-schema-409" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
- "status" : "409'",
+ "status" : "409",
"title" : "Conflicting request",
"details" : "The request cannot be processed as the resource is in use."
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Collections-createCollection-409-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Collections-createCollection-schema-409');
+ $('#responses-Decorators-updateDecorator-409-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Decorators-updateDecorator-schema-409');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Collections-createCollection-409-schema-data' type='hidden' value=''></input>
+ <input id='responses-Decorators-updateDecorator-409-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Collections-createCollection-title-500"></h3>
- <p id="examples-Collections-createCollection-description-500" class="marked"></p>
+ <h3 id="examples-Decorators-updateDecorator-title-500"></h3>
+ <p id="examples-Decorators-updateDecorator-description-500" class="marked"></p>
<script>
- var responseCollections500_description = `Internal Server Error`;
- var responseCollections500_description_break = responseCollections500_description.indexOf('\n');
- if (responseCollections500_description_break == -1) {
- $("#examples-Collections-createCollection-title-500").text("Status: 500 - " + responseCollections500_description);
+ var responseDecorators500_description = `Internal Server Error`;
+ var responseDecorators500_description_break = responseDecorators500_description.indexOf('\n');
+ if (responseDecorators500_description_break == -1) {
+ $("#examples-Decorators-updateDecorator-title-500").text("Status: 500 - " + responseDecorators500_description);
} else {
- $("#examples-Collections-createCollection-title-500").text("Status: 500 - " + responseCollections500_description.substring(0, responseCollections500_description_break));
- $("#examples-Collections-createCollection-description-500").html(responseCollections500_description.substring(responseCollections500_description_break));
+ $("#examples-Decorators-updateDecorator-title-500").text("Status: 500 - " + responseDecorators500_description.substring(0, responseDecorators500_description_break));
+ $("#examples-Decorators-updateDecorator-description-500").html(responseDecorators500_description.substring(responseDecorators500_description_break));
}
</script>
- <ul id="responses-detail-Collections-createCollection-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Decorators-updateDecorator-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Collections-createCollection-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Decorators-updateDecorator-500-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Collections-createCollection-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Collections-createCollection-500-schema">
- <div id="responses-Collections-createCollection-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-Decorators-updateDecorator-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Decorators-updateDecorator-500-schema">
+ <div id="responses-Decorators-updateDecorator-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Collections-createCollection-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Collections-createCollection-schema-500');
+ $('#responses-Decorators-updateDecorator-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Decorators-updateDecorator-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Collections-createCollection-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-Decorators-updateDecorator-500-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- <div id="api-Collections-deleteCollection">
- <article id="api-Collections-deleteCollection-0" data-group="User" data-name="deleteCollection" data-version="0">
+ </section>
+ <section id="api-EntitiesAndRelationships">
+ <h1>EntitiesAndRelationships</h1>
+ <div id="api-EntitiesAndRelationships-getAllDomains">
+ <article id="api-EntitiesAndRelationships-getAllDomains-0" data-group="User" data-name="getAllDomains" data-version="0">
<div class="pull-left">
- <h1>deleteCollection</h1>
- <p>Delete a collection with specified id.</p>
+ <h1>getAllDomains</h1>
+ <p>Get all the available topology domains.</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Delete a collection with specified id.</p>
+ <p class="marked">Get all the available topology domains.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="delete"><code><span class="pln">/collections/{collectionId}</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
- <li class="active"><a href="#examples-Collections-deleteCollection-0-curl">Curl</a></li>
- <li class=""><a href="#examples-Collections-deleteCollection-0-java">Java</a></li>
- <li class=""><a href="#examples-Collections-deleteCollection-0-dart">Dart</a></li>
- <li class=""><a href="#examples-Collections-deleteCollection-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-Collections-deleteCollection-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-Collections-deleteCollection-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-Collections-deleteCollection-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-Collections-deleteCollection-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-Collections-deleteCollection-0-csharp">C#</a></li>
- <li class=""><a href="#examples-Collections-deleteCollection-0-php">PHP</a></li>
- <li class=""><a href="#examples-Collections-deleteCollection-0-perl">Perl</a></li>
- <li class=""><a href="#examples-Collections-deleteCollection-0-python">Python</a></li>
- <li class=""><a href="#examples-Collections-deleteCollection-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-EntitiesAndRelationships-getAllDomains-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-java">Java</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-php">PHP</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-python">Python</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-Collections-deleteCollection-0-curl">
- <pre class="prettyprint"><code class="language-bsh">curl -X DELETE \
- -H "Accept: application/problem+json" \
- "https://localhost/topology-inventory/v1alpha11/collections/{collectionId}"
+ <div class="tab-pane active" id="examples-EntitiesAndRelationships-getAllDomains-0-curl">
+ <pre class="prettyprint"><code class="language-bsh">curl -X GET \
+ -H "Accept: application/json,application/problem+json" \
+ "https://localhost/topology-inventory/v1alpha11/domains?offset=56&limit=56"
</code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-deleteCollection-0-java">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-java">
<pre class="prettyprint"><code class="language-java">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();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-deleteCollection-0-dart">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-dart">
<pre class="prettyprint"><code class="language-dart">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');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-deleteCollection-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.CollectionsApi;
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-android">
+ <pre class="prettyprint"><code class="language-java">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();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-Collections-deleteCollection-0-groovy">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-Collections-deleteCollection-0-objc">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// 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);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-deleteCollection-0-javascript">
- <pre class="prettyprint"><code class="language-js">var TopologyAndInventoryApi = require('topology_and_inventory_api');
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-javascript">
+ <pre class="prettyprint"><code class="language-js">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);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-Collections-deleteCollection-0-angular">
+ <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-Collections-deleteCollection-0-csharp">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
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 );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-deleteCollection-0-php">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-php">
<pre class="prettyprint"><code class="language-php"><?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;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-deleteCollection-0-perl">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-perl">
<pre class="prettyprint"><code class="language-perl">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";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-deleteCollection-0-python">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import openapi_client
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)</code></pre>
+ print("Exception when calling EntitiesAndRelationshipsApi->getAllDomains: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-deleteCollection-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate CollectionsApi;
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-rust">
+ <pre class="prettyprint"><code class="language-rust">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);
}
<h2>Parameters</h2>
- <div class="methodsubtabletitle">Path parameters</div>
+
+ <div class="methodsubtabletitle">Header parameters</div>
<table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">collectionId*</td>
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">Accept*</td>
<td>
- <div id="d2e199_deleteCollection_collectionId">
+ <div id="d2e199_getAllDomains_accept">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
</table>
- <div class="methodsubtabletitle">Header parameters</div>
+
+
+ <div class="methodsubtabletitle">Query parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
- <tr><td style="width:150px;">Accept*</td>
+ <tr><td style="width:150px;">offset</td>
<td>
- <div id="d2e199_deleteCollection_accept">
+ <div id="d2e199_getAllDomains_offset">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
- String
+ Integer
</span>
+ <div class="inner description marked">
+Pagination offset.
+ </div>
</div>
- <div class="inner required">
- Required
- </div>
</div>
</div>
</td>
</tr>
- </table>
+ <tr><td style="width:150px;">limit</td>
+<td>
+ <div id="d2e199_getAllDomains_limit">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ Integer
+ </span>
+
+ <div class="inner description marked">
+Result limiter.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+ </table>
<h2>Responses</h2>
- <h3 id="examples-Collections-deleteCollection-title-204"></h3>
- <p id="examples-Collections-deleteCollection-description-204" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getAllDomains-title-200"></h3>
+ <p id="examples-EntitiesAndRelationships-getAllDomains-description-200" class="marked"></p>
<script>
- var responseCollections204_description = `No Content`;
- var responseCollections204_description_break = responseCollections204_description.indexOf('\n');
- if (responseCollections204_description_break == -1) {
- $("#examples-Collections-deleteCollection-title-204").text("Status: 204 - " + responseCollections204_description);
- } else {
- $("#examples-Collections-deleteCollection-title-204").text("Status: 204 - " + responseCollections204_description.substring(0, responseCollections204_description_break));
- $("#examples-Collections-deleteCollection-description-204").html(responseCollections204_description.substring(responseCollections204_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-Collections-deleteCollection-204" class="nav nav-tabs nav-tabs-examples" >
-
-
- </ul>
-
-
- <div class="tab-content" id="responses-Collections-deleteCollection-204-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Collections-deleteCollection-204-schema">
- <div id="responses-Collections-deleteCollection-schema-204" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "No Content",
- "content" : { }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema == null) {
- return;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- if (schema.properties != null) {
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- }
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-Collections-deleteCollection-204-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Collections-deleteCollection-schema-204');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-Collections-deleteCollection-204-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- <h3 id="examples-Collections-deleteCollection-title-400"></h3>
- <p id="examples-Collections-deleteCollection-description-400" class="marked"></p>
- <script>
- var responseCollections400_description = `Bad Request`;
- var responseCollections400_description_break = responseCollections400_description.indexOf('\n');
- if (responseCollections400_description_break == -1) {
- $("#examples-Collections-deleteCollection-title-400").text("Status: 400 - " + responseCollections400_description);
+ var responseEntitiesAndRelationships200_description = `OK`;
+ var responseEntitiesAndRelationships200_description_break = responseEntitiesAndRelationships200_description.indexOf('\n');
+ if (responseEntitiesAndRelationships200_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getAllDomains-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
} else {
- $("#examples-Collections-deleteCollection-title-400").text("Status: 400 - " + responseCollections400_description.substring(0, responseCollections400_description_break));
- $("#examples-Collections-deleteCollection-description-400").html(responseCollections400_description.substring(responseCollections400_description_break));
+ $("#examples-EntitiesAndRelationships-getAllDomains-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
+ $("#examples-EntitiesAndRelationships-getAllDomains-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
}
</script>
- <ul id="responses-detail-Collections-deleteCollection-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getAllDomains-200" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Collections-deleteCollection-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllDomains-200-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Collections-deleteCollection-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Collections-deleteCollection-400-schema">
- <div id="responses-Collections-deleteCollection-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getAllDomains-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllDomains-200-schema">
+ <div id="responses-EntitiesAndRelationships-getAllDomains-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Bad Request",
+ "description" : "OK",
"content" : {
- "application/problem+json" : {
+ "application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/ErrorMessage"
+ "$ref" : "#/components/schemas/Domains"
},
- "example" : {
- "status" : "400",
- "title" : "Bad Request",
- "details" : "The provided request is not valid"
+ "examples" : {
+ "domains" : {
+ "$ref" : "#/components/examples/DomainsResponseExample"
+ }
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Collections-deleteCollection-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Collections-deleteCollection-schema-400');
+ $('#responses-EntitiesAndRelationships-getAllDomains-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getAllDomains-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Collections-deleteCollection-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getAllDomains-200-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Collections-deleteCollection-title-401"></h3>
- <p id="examples-Collections-deleteCollection-description-401" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getAllDomains-title-400"></h3>
+ <p id="examples-EntitiesAndRelationships-getAllDomains-description-400" class="marked"></p>
<script>
- var responseCollections401_description = `Unauthorized`;
- var responseCollections401_description_break = responseCollections401_description.indexOf('\n');
- if (responseCollections401_description_break == -1) {
- $("#examples-Collections-deleteCollection-title-401").text("Status: 401 - " + responseCollections401_description);
+ var responseEntitiesAndRelationships400_description = `Bad Request`;
+ var responseEntitiesAndRelationships400_description_break = responseEntitiesAndRelationships400_description.indexOf('\n');
+ if (responseEntitiesAndRelationships400_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getAllDomains-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
} else {
- $("#examples-Collections-deleteCollection-title-401").text("Status: 401 - " + responseCollections401_description.substring(0, responseCollections401_description_break));
- $("#examples-Collections-deleteCollection-description-401").html(responseCollections401_description.substring(responseCollections401_description_break));
+ $("#examples-EntitiesAndRelationships-getAllDomains-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
+ $("#examples-EntitiesAndRelationships-getAllDomains-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
}
</script>
- <ul id="responses-detail-Collections-deleteCollection-401" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getAllDomains-400" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Collections-deleteCollection-401-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllDomains-400-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Collections-deleteCollection-401-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Collections-deleteCollection-401-schema">
- <div id="responses-Collections-deleteCollection-schema-401" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getAllDomains-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllDomains-400-schema">
+ <div id="responses-EntitiesAndRelationships-getAllDomains-schema-400" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Unauthorized",
+ "description" : "Bad Request",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
- "status" : "401",
- "title" : "Unauthorized request",
- "details" : "This request is unauthorized"
+ "status" : "400",
+ "title" : "Bad Request",
+ "details" : "The provided request is not valid"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Collections-deleteCollection-401-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Collections-deleteCollection-schema-401');
+ $('#responses-EntitiesAndRelationships-getAllDomains-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getAllDomains-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Collections-deleteCollection-401-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getAllDomains-400-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Collections-deleteCollection-title-403"></h3>
- <p id="examples-Collections-deleteCollection-description-403" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getAllDomains-title-401"></h3>
+ <p id="examples-EntitiesAndRelationships-getAllDomains-description-401" class="marked"></p>
<script>
- var responseCollections403_description = `Forbidden`;
- var responseCollections403_description_break = responseCollections403_description.indexOf('\n');
- if (responseCollections403_description_break == -1) {
- $("#examples-Collections-deleteCollection-title-403").text("Status: 403 - " + responseCollections403_description);
+ var responseEntitiesAndRelationships401_description = `Unauthorized`;
+ var responseEntitiesAndRelationships401_description_break = responseEntitiesAndRelationships401_description.indexOf('\n');
+ if (responseEntitiesAndRelationships401_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getAllDomains-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
} else {
- $("#examples-Collections-deleteCollection-title-403").text("Status: 403 - " + responseCollections403_description.substring(0, responseCollections403_description_break));
- $("#examples-Collections-deleteCollection-description-403").html(responseCollections403_description.substring(responseCollections403_description_break));
+ $("#examples-EntitiesAndRelationships-getAllDomains-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
+ $("#examples-EntitiesAndRelationships-getAllDomains-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
}
</script>
- <ul id="responses-detail-Collections-deleteCollection-403" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getAllDomains-401" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Collections-deleteCollection-403-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllDomains-401-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Collections-deleteCollection-403-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Collections-deleteCollection-403-schema">
- <div id="responses-Collections-deleteCollection-schema-403" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getAllDomains-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllDomains-401-schema">
+ <div id="responses-EntitiesAndRelationships-getAllDomains-schema-401" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Forbidden",
+ "description" : "Unauthorized",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
- "status" : "403",
- "title" : "Request Forbidden",
- "details" : "This request is forbidden"
+ "status" : "401",
+ "title" : "Unauthorized request",
+ "details" : "This request is unauthorized"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Collections-deleteCollection-403-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Collections-deleteCollection-schema-403');
+ $('#responses-EntitiesAndRelationships-getAllDomains-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getAllDomains-schema-401');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Collections-deleteCollection-403-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getAllDomains-401-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Collections-deleteCollection-title-404"></h3>
- <p id="examples-Collections-deleteCollection-description-404" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getAllDomains-title-403"></h3>
+ <p id="examples-EntitiesAndRelationships-getAllDomains-description-403" class="marked"></p>
<script>
- var responseCollections404_description = `Not Found`;
- var responseCollections404_description_break = responseCollections404_description.indexOf('\n');
- if (responseCollections404_description_break == -1) {
- $("#examples-Collections-deleteCollection-title-404").text("Status: 404 - " + responseCollections404_description);
+ var responseEntitiesAndRelationships403_description = `Forbidden`;
+ var responseEntitiesAndRelationships403_description_break = responseEntitiesAndRelationships403_description.indexOf('\n');
+ if (responseEntitiesAndRelationships403_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getAllDomains-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
} else {
- $("#examples-Collections-deleteCollection-title-404").text("Status: 404 - " + responseCollections404_description.substring(0, responseCollections404_description_break));
- $("#examples-Collections-deleteCollection-description-404").html(responseCollections404_description.substring(responseCollections404_description_break));
+ $("#examples-EntitiesAndRelationships-getAllDomains-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
+ $("#examples-EntitiesAndRelationships-getAllDomains-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
}
</script>
- <ul id="responses-detail-Collections-deleteCollection-404" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getAllDomains-403" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Collections-deleteCollection-404-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllDomains-403-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Collections-deleteCollection-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Collections-deleteCollection-404-schema">
- <div id="responses-Collections-deleteCollection-schema-404" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getAllDomains-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllDomains-403-schema">
+ <div id="responses-EntitiesAndRelationships-getAllDomains-schema-403" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Not Found",
+ "description" : "Forbidden",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
- "status" : "404",
- "title" : "Resource Not Found",
- "details" : "The requested resource is not found"
+ "status" : "403",
+ "title" : "Request Forbidden",
+ "details" : "This request is forbidden"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Collections-deleteCollection-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Collections-deleteCollection-schema-404');
+ $('#responses-EntitiesAndRelationships-getAllDomains-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getAllDomains-schema-403');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Collections-deleteCollection-404-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getAllDomains-403-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Collections-deleteCollection-title-500"></h3>
- <p id="examples-Collections-deleteCollection-description-500" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getAllDomains-title-500"></h3>
+ <p id="examples-EntitiesAndRelationships-getAllDomains-description-500" class="marked"></p>
<script>
- var responseCollections500_description = `Internal Server Error`;
- var responseCollections500_description_break = responseCollections500_description.indexOf('\n');
- if (responseCollections500_description_break == -1) {
- $("#examples-Collections-deleteCollection-title-500").text("Status: 500 - " + responseCollections500_description);
+ var responseEntitiesAndRelationships500_description = `Internal Server Error`;
+ var responseEntitiesAndRelationships500_description_break = responseEntitiesAndRelationships500_description.indexOf('\n');
+ if (responseEntitiesAndRelationships500_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getAllDomains-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description);
} else {
- $("#examples-Collections-deleteCollection-title-500").text("Status: 500 - " + responseCollections500_description.substring(0, responseCollections500_description_break));
- $("#examples-Collections-deleteCollection-description-500").html(responseCollections500_description.substring(responseCollections500_description_break));
+ $("#examples-EntitiesAndRelationships-getAllDomains-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description.substring(0, responseEntitiesAndRelationships500_description_break));
+ $("#examples-EntitiesAndRelationships-getAllDomains-description-500").html(responseEntitiesAndRelationships500_description.substring(responseEntitiesAndRelationships500_description_break));
}
</script>
- <ul id="responses-detail-Collections-deleteCollection-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getAllDomains-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Collections-deleteCollection-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllDomains-500-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Collections-deleteCollection-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Collections-deleteCollection-500-schema">
- <div id="responses-Collections-deleteCollection-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getAllDomains-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllDomains-500-schema">
+ <div id="responses-EntitiesAndRelationships-getAllDomains-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Collections-deleteCollection-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Collections-deleteCollection-schema-500');
+ $('#responses-EntitiesAndRelationships-getAllDomains-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getAllDomains-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Collections-deleteCollection-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getAllDomains-500-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- <div id="api-Collections-getAllCollections">
- <article id="api-Collections-getAllCollections-0" data-group="User" data-name="getAllCollections" data-version="0">
+ <div id="api-EntitiesAndRelationships-getAllRelationshipsForEntityId">
+ <article id="api-EntitiesAndRelationships-getAllRelationshipsForEntityId-0" data-group="User" data-name="getAllRelationshipsForEntityId" data-version="0">
<div class="pull-left">
- <h1>getAllCollections</h1>
- <p>Get all collections.</p>
+ <h1>getAllRelationshipsForEntityId</h1>
+ <p>Get all relationships for entity type name with specified id. Specified id represents the entity instance.</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Get all collections.</p>
+ <p class="marked">Get all relationships for entity type name with specified id. Specified id represents the entity instance.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/collections</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains/{domainName}/entity-types/{entityTypeName}/entities/{entityId}/relationships</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
- <li class="active"><a href="#examples-Collections-getAllCollections-0-curl">Curl</a></li>
- <li class=""><a href="#examples-Collections-getAllCollections-0-java">Java</a></li>
- <li class=""><a href="#examples-Collections-getAllCollections-0-dart">Dart</a></li>
- <li class=""><a href="#examples-Collections-getAllCollections-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-Collections-getAllCollections-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-Collections-getAllCollections-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-Collections-getAllCollections-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-Collections-getAllCollections-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-Collections-getAllCollections-0-csharp">C#</a></li>
- <li class=""><a href="#examples-Collections-getAllCollections-0-php">PHP</a></li>
- <li class=""><a href="#examples-Collections-getAllCollections-0-perl">Perl</a></li>
- <li class=""><a href="#examples-Collections-getAllCollections-0-python">Python</a></li>
- <li class=""><a href="#examples-Collections-getAllCollections-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-java">Java</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-php">PHP</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-python">Python</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-Collections-getAllCollections-0-curl">
+ <div class="tab-pane active" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-curl">
<pre class="prettyprint"><code class="language-bsh">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"
</code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-getAllCollections-0-java">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-java">
<pre class="prettyprint"><code class="language-java">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();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-getAllCollections-0-dart">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-dart">
<pre class="prettyprint"><code class="language-dart">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');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-getAllCollections-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.CollectionsApi;
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-android">
+ <pre class="prettyprint"><code class="language-java">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();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-Collections-getAllCollections-0-groovy">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-Collections-getAllCollections-0-objc">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// 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);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-getAllCollections-0-javascript">
- <pre class="prettyprint"><code class="language-js">var TopologyAndInventoryApi = require('topology_and_inventory_api');
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-javascript">
+ <pre class="prettyprint"><code class="language-js">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.
};
console.log('API called successfully. Returned data: ' + data);
}
};
-api.getAllCollections(accept, opts, callback);
+api.getAllRelationshipsForEntityId(accept, domainName, entityTypeName, entityId, opts, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-Collections-getAllCollections-0-angular">
+ <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-Collections-getAllCollections-0-csharp">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
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 );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-getAllCollections-0-php">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-php">
<pre class="prettyprint"><code class="language-php"><?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;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-getAllCollections-0-perl">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-perl">
<pre class="prettyprint"><code class="language-perl">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";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-getAllCollections-0-python">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import openapi_client
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)</code></pre>
+ print("Exception when calling EntitiesAndRelationshipsApi->getAllRelationshipsForEntityId: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-getAllCollections-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate CollectionsApi;
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-rust">
+ <pre class="prettyprint"><code class="language-rust">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);
}
<h2>Parameters</h2>
+ <div class="methodsubtabletitle">Path parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">domainName*</td>
+<td>
+
+
+ <div id="d2e199_getAllRelationshipsForEntityId_domainName">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ <div class="inner description marked">
+domain name
+ </div>
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">entityTypeName*</td>
+<td>
+
+
+ <div id="d2e199_getAllRelationshipsForEntityId_entityTypeName">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">entityId*</td>
+<td>
+
+
+ <div id="d2e199_getAllRelationshipsForEntityId_entityId">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ </table>
<div class="methodsubtabletitle">Header parameters</div>
<table id="methodsubtable">
<td>
- <div id="d2e199_getAllCollections_accept">
+ <div id="d2e199_getAllRelationshipsForEntityId_accept">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
<th width="150px">Name</th>
<th>Description</th>
</tr>
+ <tr><td style="width:150px;">targetFilter</td>
+<td>
+
+
+ <div id="d2e199_getAllRelationshipsForEntityId_targetFilter">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ <div class="inner description marked">
+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.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">scopeFilter</td>
+<td>
+
+
+ <div id="d2e199_getAllRelationshipsForEntityId_scopeFilter">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ <div class="inner description marked">
+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.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
<tr><td style="width:150px;">offset</td>
<td>
- <div id="d2e199_getAllCollections_offset">
+ <div id="d2e199_getAllRelationshipsForEntityId_offset">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
<td>
- <div id="d2e199_getAllCollections_limit">
+ <div id="d2e199_getAllRelationshipsForEntityId_limit">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
</table>
<h2>Responses</h2>
- <h3 id="examples-Collections-getAllCollections-title-200"></h3>
- <p id="examples-Collections-getAllCollections-description-200" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-200"></h3>
+ <p id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-200" class="marked"></p>
<script>
- var responseCollections200_description = `OK`;
- var responseCollections200_description_break = responseCollections200_description.indexOf('\n');
- if (responseCollections200_description_break == -1) {
- $("#examples-Collections-getAllCollections-title-200").text("Status: 200 - " + responseCollections200_description);
+ var responseEntitiesAndRelationships200_description = `OK`;
+ var responseEntitiesAndRelationships200_description_break = responseEntitiesAndRelationships200_description.indexOf('\n');
+ if (responseEntitiesAndRelationships200_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
} else {
- $("#examples-Collections-getAllCollections-title-200").text("Status: 200 - " + responseCollections200_description.substring(0, responseCollections200_description_break));
- $("#examples-Collections-getAllCollections-description-200").html(responseCollections200_description.substring(responseCollections200_description_break));
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
}
</script>
- <ul id="responses-detail-Collections-getAllCollections-200" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getAllRelationshipsForEntityId-200" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Collections-getAllCollections-200-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-200-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Collections-getAllCollections-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Collections-getAllCollections-200-schema">
- <div id="responses-Collections-getAllCollections-schema-200" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-200-schema">
+ <div id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/Collections"
+ "$ref" : "#/components/schemas/RelationshipsResponseMessage"
},
"examples" : {
- "collections" : {
- "$ref" : "#/components/examples/CollectionsResponseExample"
+ "relationships" : {
+ "$ref" : "#/components/examples/RelationshipsResponseExample"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Collections-getAllCollections-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Collections-getAllCollections-schema-200');
+ $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Collections-getAllCollections-200-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-200-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Collections-getAllCollections-title-204"></h3>
- <p id="examples-Collections-getAllCollections-description-204" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-400"></h3>
+ <p id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-400" class="marked"></p>
<script>
- var responseCollections204_description = `No Content`;
- var responseCollections204_description_break = responseCollections204_description.indexOf('\n');
- if (responseCollections204_description_break == -1) {
- $("#examples-Collections-getAllCollections-title-204").text("Status: 204 - " + responseCollections204_description);
+ var responseEntitiesAndRelationships400_description = `Bad Request`;
+ var responseEntitiesAndRelationships400_description_break = responseEntitiesAndRelationships400_description.indexOf('\n');
+ if (responseEntitiesAndRelationships400_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
} else {
- $("#examples-Collections-getAllCollections-title-204").text("Status: 204 - " + responseCollections204_description.substring(0, responseCollections204_description_break));
- $("#examples-Collections-getAllCollections-description-204").html(responseCollections204_description.substring(responseCollections204_description_break));
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
}
</script>
- <ul id="responses-detail-Collections-getAllCollections-204" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getAllRelationshipsForEntityId-400" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-400-schema">Schema</a>
+ </li>
+
+
</ul>
- <div class="tab-content" id="responses-Collections-getAllCollections-204-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Collections-getAllCollections-204-schema">
- <div id="responses-Collections-getAllCollections-schema-204" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-400-schema">
+ <div id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-400" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "No Content",
- "content" : { }
+ "description" : "Bad Request",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ },
+ "example" : {
+ "status" : "400",
+ "title" : "Bad Request",
+ "details" : "The provided request is not valid"
+ }
+ }
+ }
};
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Collections-getAllCollections-204-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Collections-getAllCollections-schema-204');
+ $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Collections-getAllCollections-204-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-400-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Collections-getAllCollections-title-400"></h3>
- <p id="examples-Collections-getAllCollections-description-400" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-401"></h3>
+ <p id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-401" class="marked"></p>
<script>
- var responseCollections400_description = `Bad Request`;
- var responseCollections400_description_break = responseCollections400_description.indexOf('\n');
- if (responseCollections400_description_break == -1) {
- $("#examples-Collections-getAllCollections-title-400").text("Status: 400 - " + responseCollections400_description);
+ var responseEntitiesAndRelationships401_description = `Unauthorized`;
+ var responseEntitiesAndRelationships401_description_break = responseEntitiesAndRelationships401_description.indexOf('\n');
+ if (responseEntitiesAndRelationships401_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
} else {
- $("#examples-Collections-getAllCollections-title-400").text("Status: 400 - " + responseCollections400_description.substring(0, responseCollections400_description_break));
- $("#examples-Collections-getAllCollections-description-400").html(responseCollections400_description.substring(responseCollections400_description_break));
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
}
</script>
- <ul id="responses-detail-Collections-getAllCollections-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getAllRelationshipsForEntityId-401" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Collections-getAllCollections-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-401-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Collections-getAllCollections-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Collections-getAllCollections-400-schema">
- <div id="responses-Collections-getAllCollections-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-401-schema">
+ <div id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-401" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Bad Request",
+ "description" : "Unauthorized",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
- "status" : "400",
- "title" : "Bad Request",
- "details" : "The provided request is not valid"
+ "status" : "401",
+ "title" : "Unauthorized request",
+ "details" : "This request is unauthorized"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Collections-getAllCollections-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Collections-getAllCollections-schema-400');
+ $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-401');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Collections-getAllCollections-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-401-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Collections-getAllCollections-title-401"></h3>
- <p id="examples-Collections-getAllCollections-description-401" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-403"></h3>
+ <p id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-403" class="marked"></p>
<script>
- var responseCollections401_description = `Unauthorized`;
- var responseCollections401_description_break = responseCollections401_description.indexOf('\n');
- if (responseCollections401_description_break == -1) {
- $("#examples-Collections-getAllCollections-title-401").text("Status: 401 - " + responseCollections401_description);
+ var responseEntitiesAndRelationships403_description = `Forbidden`;
+ var responseEntitiesAndRelationships403_description_break = responseEntitiesAndRelationships403_description.indexOf('\n');
+ if (responseEntitiesAndRelationships403_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
} else {
- $("#examples-Collections-getAllCollections-title-401").text("Status: 401 - " + responseCollections401_description.substring(0, responseCollections401_description_break));
- $("#examples-Collections-getAllCollections-description-401").html(responseCollections401_description.substring(responseCollections401_description_break));
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
}
</script>
- <ul id="responses-detail-Collections-getAllCollections-401" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getAllRelationshipsForEntityId-403" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Collections-getAllCollections-401-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-403-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Collections-getAllCollections-401-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Collections-getAllCollections-401-schema">
- <div id="responses-Collections-getAllCollections-schema-401" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-403-schema">
+ <div id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-403" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Unauthorized",
+ "description" : "Forbidden",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
- "status" : "401",
- "title" : "Unauthorized request",
- "details" : "This request is unauthorized"
+ "status" : "403",
+ "title" : "Request Forbidden",
+ "details" : "This request is forbidden"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Collections-getAllCollections-401-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Collections-getAllCollections-schema-401');
+ $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-403');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Collections-getAllCollections-401-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-403-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Collections-getAllCollections-title-403"></h3>
- <p id="examples-Collections-getAllCollections-description-403" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-404"></h3>
+ <p id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-404" class="marked"></p>
<script>
- var responseCollections403_description = `Forbidden`;
- var responseCollections403_description_break = responseCollections403_description.indexOf('\n');
- if (responseCollections403_description_break == -1) {
- $("#examples-Collections-getAllCollections-title-403").text("Status: 403 - " + responseCollections403_description);
+ var responseEntitiesAndRelationships404_description = `Not Found`;
+ var responseEntitiesAndRelationships404_description_break = responseEntitiesAndRelationships404_description.indexOf('\n');
+ if (responseEntitiesAndRelationships404_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description);
} else {
- $("#examples-Collections-getAllCollections-title-403").text("Status: 403 - " + responseCollections403_description.substring(0, responseCollections403_description_break));
- $("#examples-Collections-getAllCollections-description-403").html(responseCollections403_description.substring(responseCollections403_description_break));
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description.substring(0, responseEntitiesAndRelationships404_description_break));
+ $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-404").html(responseEntitiesAndRelationships404_description.substring(responseEntitiesAndRelationships404_description_break));
}
</script>
- <ul id="responses-detail-Collections-getAllCollections-403" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getAllRelationshipsForEntityId-404" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Collections-getAllCollections-403-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-404-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Collections-getAllCollections-403-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Collections-getAllCollections-403-schema">
- <div id="responses-Collections-getAllCollections-schema-403" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-404-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-404-schema">
+ <div id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-404" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Forbidden",
+ "description" : "Not Found",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
- "status" : "403",
- "title" : "Request Forbidden",
- "details" : "This request is forbidden"
+ "status" : "404",
+ "title" : "Resource Not Found",
+ "details" : "The requested resource is not found"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Collections-getAllCollections-403-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Collections-getAllCollections-schema-403');
+ $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-404-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-404');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Collections-getAllCollections-403-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-404-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Collections-getAllCollections-title-500"></h3>
- <p id="examples-Collections-getAllCollections-description-500" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-500"></h3>
+ <p id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-500" class="marked"></p>
<script>
- var responseCollections500_description = `Internal Server Error`;
- var responseCollections500_description_break = responseCollections500_description.indexOf('\n');
- if (responseCollections500_description_break == -1) {
- $("#examples-Collections-getAllCollections-title-500").text("Status: 500 - " + responseCollections500_description);
- } else {
- $("#examples-Collections-getAllCollections-title-500").text("Status: 500 - " + responseCollections500_description.substring(0, responseCollections500_description_break));
- $("#examples-Collections-getAllCollections-description-500").html(responseCollections500_description.substring(responseCollections500_description_break));
- }
- </script>
+ 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));
+ }
+ </script>
- <ul id="responses-detail-Collections-getAllCollections-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getAllRelationshipsForEntityId-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Collections-getAllCollections-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-500-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Collections-getAllCollections-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Collections-getAllCollections-500-schema">
- <div id="responses-Collections-getAllCollections-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-500-schema">
+ <div id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Collections-getAllCollections-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Collections-getAllCollections-schema-500');
+ $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Collections-getAllCollections-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-500-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- <div id="api-Collections-getCollection">
- <article id="api-Collections-getCollection-0" data-group="User" data-name="getCollection" data-version="0">
+ <div id="api-EntitiesAndRelationships-getEntitiesByDomain">
+ <article id="api-EntitiesAndRelationships-getEntitiesByDomain-0" data-group="User" data-name="getEntitiesByDomain" data-version="0">
<div class="pull-left">
- <h1>getCollection</h1>
- <p>Get a collection with specified id.</p>
+ <h1>getEntitiesByDomain</h1>
+ <p>Get entities by domain</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Get a collection with specified id.</p>
+ <p class="marked">Get topology entities by domain, using specified targetFilter as mandatory query parameter.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/collections/{collectionId}</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains/{domainName}/entities</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
- <li class="active"><a href="#examples-Collections-getCollection-0-curl">Curl</a></li>
- <li class=""><a href="#examples-Collections-getCollection-0-java">Java</a></li>
- <li class=""><a href="#examples-Collections-getCollection-0-dart">Dart</a></li>
- <li class=""><a href="#examples-Collections-getCollection-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-Collections-getCollection-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-Collections-getCollection-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-Collections-getCollection-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-Collections-getCollection-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-Collections-getCollection-0-csharp">C#</a></li>
- <li class=""><a href="#examples-Collections-getCollection-0-php">PHP</a></li>
- <li class=""><a href="#examples-Collections-getCollection-0-perl">Perl</a></li>
- <li class=""><a href="#examples-Collections-getCollection-0-python">Python</a></li>
- <li class=""><a href="#examples-Collections-getCollection-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-java">Java</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-php">PHP</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-python">Python</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-Collections-getCollection-0-curl">
+ <div class="tab-pane active" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-curl">
<pre class="prettyprint"><code class="language-bsh">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"
</code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-getCollection-0-java">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-java">
<pre class="prettyprint"><code class="language-java">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();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-getCollection-0-dart">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-dart">
<pre class="prettyprint"><code class="language-dart">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');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-getCollection-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.CollectionsApi;
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-android">
+ <pre class="prettyprint"><code class="language-java">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();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-Collections-getCollection-0-groovy">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-Collections-getCollection-0-objc">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// 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);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-getCollection-0-javascript">
- <pre class="prettyprint"><code class="language-js">var TopologyAndInventoryApi = require('topology_and_inventory_api');
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-javascript">
+ <pre class="prettyprint"><code class="language-js">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) {
console.log('API called successfully. Returned data: ' + data);
}
};
-api.getCollection(accept, collectionId, callback);
+api.getEntitiesByDomain(accept, domainName, opts, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-Collections-getCollection-0-angular">
+ <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-Collections-getCollection-0-csharp">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
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 );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-getCollection-0-php">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-php">
<pre class="prettyprint"><code class="language-php"><?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;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-getCollection-0-perl">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-perl">
<pre class="prettyprint"><code class="language-perl">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";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-getCollection-0-python">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import openapi_client
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)</code></pre>
+ print("Exception when calling EntitiesAndRelationshipsApi->getEntitiesByDomain: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-getCollection-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate CollectionsApi;
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-rust">
+ <pre class="prettyprint"><code class="language-rust">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);
}
<th width="150px">Name</th>
<th>Description</th>
</tr>
- <tr><td style="width:150px;">collectionId*</td>
+ <tr><td style="width:150px;">domainName*</td>
<td>
- <div id="d2e199_getCollection_collectionId">
+ <div id="d2e199_getEntitiesByDomain_domainName">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
String
</span>
+ <div class="inner description marked">
+domain name
+ </div>
</div>
<div class="inner required">
Required
<td>
- <div id="d2e199_getCollection_accept">
+ <div id="d2e199_getEntitiesByDomain_accept">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
+ <div class="methodsubtabletitle">Query parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">targetFilter</td>
+<td>
+
+
+ <div id="d2e199_getEntitiesByDomain_targetFilter">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ <div class="inner description marked">
+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.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">scopeFilter</td>
+<td>
+
+
+ <div id="d2e199_getEntitiesByDomain_scopeFilter">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ <div class="inner description marked">
+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.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">offset</td>
+<td>
+
+
+ <div id="d2e199_getEntitiesByDomain_offset">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ Integer
+ </span>
+
+ <div class="inner description marked">
+Pagination offset.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">limit</td>
+<td>
+
+
+ <div id="d2e199_getEntitiesByDomain_limit">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ Integer
+ </span>
+
+ <div class="inner description marked">
+Result limiter.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ </table>
<h2>Responses</h2>
- <h3 id="examples-Collections-getCollection-title-200"></h3>
- <p id="examples-Collections-getCollection-description-200" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getEntitiesByDomain-title-200"></h3>
+ <p id="examples-EntitiesAndRelationships-getEntitiesByDomain-description-200" class="marked"></p>
<script>
- var responseCollections200_description = `OK`;
- var responseCollections200_description_break = responseCollections200_description.indexOf('\n');
- if (responseCollections200_description_break == -1) {
- $("#examples-Collections-getCollection-title-200").text("Status: 200 - " + responseCollections200_description);
+ var responseEntitiesAndRelationships200_description = `OK`;
+ var responseEntitiesAndRelationships200_description_break = responseEntitiesAndRelationships200_description.indexOf('\n');
+ if (responseEntitiesAndRelationships200_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
} else {
- $("#examples-Collections-getCollection-title-200").text("Status: 200 - " + responseCollections200_description.substring(0, responseCollections200_description_break));
- $("#examples-Collections-getCollection-description-200").html(responseCollections200_description.substring(responseCollections200_description_break));
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
}
</script>
- <ul id="responses-detail-Collections-getCollection-200" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getEntitiesByDomain-200" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Collections-getCollection-200-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getEntitiesByDomain-200-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Collections-getCollection-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Collections-getCollection-200-schema">
- <div id="responses-Collections-getCollection-schema-200" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getEntitiesByDomain-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getEntitiesByDomain-200-schema">
+ <div id="responses-EntitiesAndRelationships-getEntitiesByDomain-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/CollectionResponse"
+ "$ref" : "#/components/schemas/EntitiesResponseMessage"
},
"examples" : {
- "collection" : {
- "$ref" : "#/components/examples/CollectionResponseExample"
+ "entities" : {
+ "$ref" : "#/components/examples/EntitiesResponseExample"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Collections-getCollection-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Collections-getCollection-schema-200');
+ $('#responses-EntitiesAndRelationships-getEntitiesByDomain-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getEntitiesByDomain-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Collections-getCollection-200-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getEntitiesByDomain-200-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Collections-getCollection-title-400"></h3>
- <p id="examples-Collections-getCollection-description-400" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getEntitiesByDomain-title-400"></h3>
+ <p id="examples-EntitiesAndRelationships-getEntitiesByDomain-description-400" class="marked"></p>
<script>
- var responseCollections400_description = `Bad Request`;
- var responseCollections400_description_break = responseCollections400_description.indexOf('\n');
- if (responseCollections400_description_break == -1) {
- $("#examples-Collections-getCollection-title-400").text("Status: 400 - " + responseCollections400_description);
+ var responseEntitiesAndRelationships400_description = `Bad Request`;
+ var responseEntitiesAndRelationships400_description_break = responseEntitiesAndRelationships400_description.indexOf('\n');
+ if (responseEntitiesAndRelationships400_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
} else {
- $("#examples-Collections-getCollection-title-400").text("Status: 400 - " + responseCollections400_description.substring(0, responseCollections400_description_break));
- $("#examples-Collections-getCollection-description-400").html(responseCollections400_description.substring(responseCollections400_description_break));
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
}
</script>
- <ul id="responses-detail-Collections-getCollection-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getEntitiesByDomain-400" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Collections-getCollection-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getEntitiesByDomain-400-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Collections-getCollection-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Collections-getCollection-400-schema">
- <div id="responses-Collections-getCollection-schema-400" class="exampleStyle">
- <script>
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getEntitiesByDomain-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getEntitiesByDomain-400-schema">
+ <div id="responses-EntitiesAndRelationships-getEntitiesByDomain-schema-400" class="exampleStyle">
+ <script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "Bad Request",
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Collections-getCollection-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Collections-getCollection-schema-400');
+ $('#responses-EntitiesAndRelationships-getEntitiesByDomain-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getEntitiesByDomain-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Collections-getCollection-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getEntitiesByDomain-400-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Collections-getCollection-title-401"></h3>
- <p id="examples-Collections-getCollection-description-401" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getEntitiesByDomain-title-401"></h3>
+ <p id="examples-EntitiesAndRelationships-getEntitiesByDomain-description-401" class="marked"></p>
<script>
- var responseCollections401_description = `Unauthorized`;
- var responseCollections401_description_break = responseCollections401_description.indexOf('\n');
- if (responseCollections401_description_break == -1) {
- $("#examples-Collections-getCollection-title-401").text("Status: 401 - " + responseCollections401_description);
+ var responseEntitiesAndRelationships401_description = `Unauthorized`;
+ var responseEntitiesAndRelationships401_description_break = responseEntitiesAndRelationships401_description.indexOf('\n');
+ if (responseEntitiesAndRelationships401_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
} else {
- $("#examples-Collections-getCollection-title-401").text("Status: 401 - " + responseCollections401_description.substring(0, responseCollections401_description_break));
- $("#examples-Collections-getCollection-description-401").html(responseCollections401_description.substring(responseCollections401_description_break));
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
}
</script>
- <ul id="responses-detail-Collections-getCollection-401" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getEntitiesByDomain-401" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Collections-getCollection-401-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getEntitiesByDomain-401-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Collections-getCollection-401-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Collections-getCollection-401-schema">
- <div id="responses-Collections-getCollection-schema-401" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getEntitiesByDomain-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getEntitiesByDomain-401-schema">
+ <div id="responses-EntitiesAndRelationships-getEntitiesByDomain-schema-401" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Collections-getCollection-401-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Collections-getCollection-schema-401');
+ $('#responses-EntitiesAndRelationships-getEntitiesByDomain-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getEntitiesByDomain-schema-401');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Collections-getCollection-401-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getEntitiesByDomain-401-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Collections-getCollection-title-403"></h3>
- <p id="examples-Collections-getCollection-description-403" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getEntitiesByDomain-title-403"></h3>
+ <p id="examples-EntitiesAndRelationships-getEntitiesByDomain-description-403" class="marked"></p>
<script>
- var responseCollections403_description = `Forbidden`;
- var responseCollections403_description_break = responseCollections403_description.indexOf('\n');
- if (responseCollections403_description_break == -1) {
- $("#examples-Collections-getCollection-title-403").text("Status: 403 - " + responseCollections403_description);
+ var responseEntitiesAndRelationships403_description = `Forbidden`;
+ var responseEntitiesAndRelationships403_description_break = responseEntitiesAndRelationships403_description.indexOf('\n');
+ if (responseEntitiesAndRelationships403_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
} else {
- $("#examples-Collections-getCollection-title-403").text("Status: 403 - " + responseCollections403_description.substring(0, responseCollections403_description_break));
- $("#examples-Collections-getCollection-description-403").html(responseCollections403_description.substring(responseCollections403_description_break));
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
}
</script>
- <ul id="responses-detail-Collections-getCollection-403" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getEntitiesByDomain-403" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Collections-getCollection-403-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getEntitiesByDomain-403-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Collections-getCollection-403-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Collections-getCollection-403-schema">
- <div id="responses-Collections-getCollection-schema-403" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getEntitiesByDomain-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getEntitiesByDomain-403-schema">
+ <div id="responses-EntitiesAndRelationships-getEntitiesByDomain-schema-403" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Collections-getCollection-403-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Collections-getCollection-schema-403');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-Collections-getCollection-403-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- <h3 id="examples-Collections-getCollection-title-404"></h3>
- <p id="examples-Collections-getCollection-description-404" class="marked"></p>
- <script>
- var responseCollections404_description = `Not Found`;
- var responseCollections404_description_break = responseCollections404_description.indexOf('\n');
- if (responseCollections404_description_break == -1) {
- $("#examples-Collections-getCollection-title-404").text("Status: 404 - " + responseCollections404_description);
- } else {
- $("#examples-Collections-getCollection-title-404").text("Status: 404 - " + responseCollections404_description.substring(0, responseCollections404_description_break));
- $("#examples-Collections-getCollection-description-404").html(responseCollections404_description.substring(responseCollections404_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-Collections-getCollection-404" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-Collections-getCollection-404-schema">Schema</a>
- </li>
-
-
-
-
- </ul>
-
-
- <div class="tab-content" id="responses-Collections-getCollection-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Collections-getCollection-404-schema">
- <div id="responses-Collections-getCollection-schema-404" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "Not Found",
- "content" : {
- "application/problem+json" : {
- "schema" : {
- "$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "404",
- "title" : "Resource Not Found",
- "details" : "The requested resource is not found"
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema == null) {
- return;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- if (schema.properties != null) {
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- }
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-Collections-getCollection-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Collections-getCollection-schema-404');
+ $('#responses-EntitiesAndRelationships-getEntitiesByDomain-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getEntitiesByDomain-schema-403');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Collections-getCollection-404-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getEntitiesByDomain-403-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Collections-getCollection-title-500"></h3>
- <p id="examples-Collections-getCollection-description-500" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getEntitiesByDomain-title-500"></h3>
+ <p id="examples-EntitiesAndRelationships-getEntitiesByDomain-description-500" class="marked"></p>
<script>
- var responseCollections500_description = `Internal Server Error`;
- var responseCollections500_description_break = responseCollections500_description.indexOf('\n');
- if (responseCollections500_description_break == -1) {
- $("#examples-Collections-getCollection-title-500").text("Status: 500 - " + responseCollections500_description);
+ var responseEntitiesAndRelationships500_description = `Internal Server Error`;
+ var responseEntitiesAndRelationships500_description_break = responseEntitiesAndRelationships500_description.indexOf('\n');
+ if (responseEntitiesAndRelationships500_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description);
} else {
- $("#examples-Collections-getCollection-title-500").text("Status: 500 - " + responseCollections500_description.substring(0, responseCollections500_description_break));
- $("#examples-Collections-getCollection-description-500").html(responseCollections500_description.substring(responseCollections500_description_break));
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description.substring(0, responseEntitiesAndRelationships500_description_break));
+ $("#examples-EntitiesAndRelationships-getEntitiesByDomain-description-500").html(responseEntitiesAndRelationships500_description.substring(responseEntitiesAndRelationships500_description_break));
}
</script>
- <ul id="responses-detail-Collections-getCollection-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getEntitiesByDomain-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Collections-getCollection-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getEntitiesByDomain-500-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Collections-getCollection-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Collections-getCollection-500-schema">
- <div id="responses-Collections-getCollection-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getEntitiesByDomain-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getEntitiesByDomain-500-schema">
+ <div id="responses-EntitiesAndRelationships-getEntitiesByDomain-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Collections-getCollection-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Collections-getCollection-schema-500');
+ $('#responses-EntitiesAndRelationships-getEntitiesByDomain-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getEntitiesByDomain-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Collections-getCollection-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getEntitiesByDomain-500-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- <div id="api-Collections-updateCollection">
- <article id="api-Collections-updateCollection-0" data-group="User" data-name="updateCollection" data-version="0">
+ <div id="api-EntitiesAndRelationships-getRelationshipById">
+ <article id="api-EntitiesAndRelationships-getRelationshipById-0" data-group="User" data-name="getRelationshipById" data-version="0">
<div class="pull-left">
- <h1>updateCollection</h1>
- <p>Update a collection.</p>
+ <h1>getRelationshipById</h1>
+ <p>Get relationship with specified id. Specified id represents the relationship instance.</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Update a collection.</p>
+ <p class="marked">Get relationship with specified id. Specified id represents the relationship instance.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/collections/{collectionId}</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains/{domainName}/relationship-types/{relationshipTypeName}/relationships/{relationshipId}</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
- <li class="active"><a href="#examples-Collections-updateCollection-0-curl">Curl</a></li>
- <li class=""><a href="#examples-Collections-updateCollection-0-java">Java</a></li>
- <li class=""><a href="#examples-Collections-updateCollection-0-dart">Dart</a></li>
- <li class=""><a href="#examples-Collections-updateCollection-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-Collections-updateCollection-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-Collections-updateCollection-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-Collections-updateCollection-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-Collections-updateCollection-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-Collections-updateCollection-0-csharp">C#</a></li>
- <li class=""><a href="#examples-Collections-updateCollection-0-php">PHP</a></li>
- <li class=""><a href="#examples-Collections-updateCollection-0-perl">Perl</a></li>
- <li class=""><a href="#examples-Collections-updateCollection-0-python">Python</a></li>
- <li class=""><a href="#examples-Collections-updateCollection-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-java">Java</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-php">PHP</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-python">Python</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-Collections-updateCollection-0-curl">
- <pre class="prettyprint"><code class="language-bsh">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"
-}'
+ <div class="tab-pane active" id="examples-EntitiesAndRelationships-getRelationshipById-0-curl">
+ <pre class="prettyprint"><code class="language-bsh">curl -X GET \
+ -H "Accept: application/yang.data+json,application/problem+json" \
+ "https://localhost/topology-inventory/v1alpha11/domains/{domainName}/relationship-types/{relationshipTypeName}/relationships/{relationshipId}"
</code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-updateCollection-0-java">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-java">
<pre class="prettyprint"><code class="language-java">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();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-updateCollection-0-dart">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-dart">
<pre class="prettyprint"><code class="language-dart">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');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-updateCollection-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.CollectionsApi;
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-android">
+ <pre class="prettyprint"><code class="language-java">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();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-Collections-updateCollection-0-groovy">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-Collections-updateCollection-0-objc">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// 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);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-updateCollection-0-javascript">
- <pre class="prettyprint"><code class="language-js">var TopologyAndInventoryApi = require('topology_and_inventory_api');
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-javascript">
+ <pre class="prettyprint"><code class="language-js">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);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-Collections-updateCollection-0-angular">
+ <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-Collections-updateCollection-0-csharp">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
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 );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-updateCollection-0-php">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-php">
<pre class="prettyprint"><code class="language-php"><?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;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-updateCollection-0-perl">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-perl">
<pre class="prettyprint"><code class="language-perl">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";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-updateCollection-0-python">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import openapi_client
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)</code></pre>
+ print("Exception when calling EntitiesAndRelationshipsApi->getRelationshipById: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-Collections-updateCollection-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate CollectionsApi;
-
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-rust">
+ <pre class="prettyprint"><code class="language-rust">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);
}
<th width="150px">Name</th>
<th>Description</th>
</tr>
- <tr><td style="width:150px;">collectionId*</td>
+ <tr><td style="width:150px;">domainName*</td>
<td>
- <div id="d2e199_updateCollection_collectionId">
+ <div id="d2e199_getRelationshipById_domainName">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
String
</span>
+ <div class="inner description marked">
+domain name
+ </div>
</div>
<div class="inner required">
Required
</td>
</tr>
- </table>
-
- <div class="methodsubtabletitle">Header parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">Accept*</td>
+ <tr><td style="width:150px;">relationshipTypeName*</td>
<td>
- <div id="d2e199_updateCollection_accept">
+ <div id="d2e199_getRelationshipById_relationshipTypeName">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
</td>
</tr>
- <tr><td style="width:150px;">Content-Type*</td>
+ <tr><td style="width:150px;">relationshipId*</td>
<td>
- <div id="d2e199_updateCollection_contentType">
+ <div id="d2e199_getRelationshipById_relationshipId">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
</table>
- <div class="methodsubtabletitle">Body parameters</div>
+ <div class="methodsubtabletitle">Header parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
- <tr><td style="width:150px;">collection <span style="color:red;">*</span></td>
+ <tr><td style="width:150px;">Accept*</td>
<td>
-<p class="marked"></p>
-<script>
-$(document).ready(function() {
- var schemaWrapper = {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/Collection"
- },
- "examples" : {
- "dynamicCollection" : {
- "$ref" : "#/components/examples/DynamicCollectionExample"
- },
- "staticCollection" : {
- "$ref" : "#/components/examples/StaticCollectionExample"
- }
- }
- }
- },
- "required" : true
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
- var view = new JSONSchemaView(schema,2,{isBodyParam: true});
- var result = $('#d2e199_updateCollection_collection');
- result.empty();
- result.append(view.render());
-});
-</script>
-<div id="d2e199_updateCollection_collection"></div>
+ <div id="d2e199_getRelationshipById_accept">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
</td>
</tr>
+
<h2>Responses</h2>
- <h3 id="examples-Collections-updateCollection-title-204"></h3>
- <p id="examples-Collections-updateCollection-description-204" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getRelationshipById-title-200"></h3>
+ <p id="examples-EntitiesAndRelationships-getRelationshipById-description-200" class="marked"></p>
<script>
- var responseCollections204_description = `No Content`;
- var responseCollections204_description_break = responseCollections204_description.indexOf('\n');
- if (responseCollections204_description_break == -1) {
- $("#examples-Collections-updateCollection-title-204").text("Status: 204 - " + responseCollections204_description);
+ var responseEntitiesAndRelationships200_description = `OK`;
+ var responseEntitiesAndRelationships200_description_break = responseEntitiesAndRelationships200_description.indexOf('\n');
+ if (responseEntitiesAndRelationships200_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getRelationshipById-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
} else {
- $("#examples-Collections-updateCollection-title-204").text("Status: 204 - " + responseCollections204_description.substring(0, responseCollections204_description_break));
- $("#examples-Collections-updateCollection-description-204").html(responseCollections204_description.substring(responseCollections204_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipById-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipById-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
}
</script>
- <ul id="responses-detail-Collections-updateCollection-204" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getRelationshipById-200" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipById-200-schema">Schema</a>
+ </li>
+
+
</ul>
- <div class="tab-content" id="responses-Collections-updateCollection-204-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Collections-updateCollection-204-schema">
- <div id="responses-Collections-updateCollection-schema-204" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipById-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipById-200-schema">
+ <div id="responses-EntitiesAndRelationships-getRelationshipById-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "No Content",
- "content" : { }
+ "description" : "OK",
+ "content" : {
+ "application/yang.data+json" : {
+ "schema" : {
+ "type" : "object",
+ "description" : "Refer to yang model for schema definition"
+ },
+ "examples" : {
+ "relationship" : {
+ "$ref" : "#/components/examples/RelationshipResponseExample"
+ }
+ }
+ }
+ }
};
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Collections-updateCollection-204-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Collections-updateCollection-schema-204');
+ $('#responses-EntitiesAndRelationships-getRelationshipById-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getRelationshipById-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Collections-updateCollection-204-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getRelationshipById-200-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Collections-updateCollection-title-400"></h3>
- <p id="examples-Collections-updateCollection-description-400" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getRelationshipById-title-400"></h3>
+ <p id="examples-EntitiesAndRelationships-getRelationshipById-description-400" class="marked"></p>
<script>
- var responseCollections400_description = `Bad Request`;
- var responseCollections400_description_break = responseCollections400_description.indexOf('\n');
- if (responseCollections400_description_break == -1) {
- $("#examples-Collections-updateCollection-title-400").text("Status: 400 - " + responseCollections400_description);
+ var responseEntitiesAndRelationships400_description = `Bad Request`;
+ var responseEntitiesAndRelationships400_description_break = responseEntitiesAndRelationships400_description.indexOf('\n');
+ if (responseEntitiesAndRelationships400_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getRelationshipById-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
} else {
- $("#examples-Collections-updateCollection-title-400").text("Status: 400 - " + responseCollections400_description.substring(0, responseCollections400_description_break));
- $("#examples-Collections-updateCollection-description-400").html(responseCollections400_description.substring(responseCollections400_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipById-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipById-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
}
</script>
- <ul id="responses-detail-Collections-updateCollection-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getRelationshipById-400" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Collections-updateCollection-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipById-400-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Collections-updateCollection-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Collections-updateCollection-400-schema">
- <div id="responses-Collections-updateCollection-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipById-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipById-400-schema">
+ <div id="responses-EntitiesAndRelationships-getRelationshipById-schema-400" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Collections-updateCollection-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Collections-updateCollection-schema-400');
+ $('#responses-EntitiesAndRelationships-getRelationshipById-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getRelationshipById-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Collections-updateCollection-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getRelationshipById-400-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Collections-updateCollection-title-401"></h3>
- <p id="examples-Collections-updateCollection-description-401" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getRelationshipById-title-401"></h3>
+ <p id="examples-EntitiesAndRelationships-getRelationshipById-description-401" class="marked"></p>
<script>
- var responseCollections401_description = `Unauthorized`;
- var responseCollections401_description_break = responseCollections401_description.indexOf('\n');
- if (responseCollections401_description_break == -1) {
- $("#examples-Collections-updateCollection-title-401").text("Status: 401 - " + responseCollections401_description);
+ var responseEntitiesAndRelationships401_description = `Unauthorized`;
+ var responseEntitiesAndRelationships401_description_break = responseEntitiesAndRelationships401_description.indexOf('\n');
+ if (responseEntitiesAndRelationships401_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getRelationshipById-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
} else {
- $("#examples-Collections-updateCollection-title-401").text("Status: 401 - " + responseCollections401_description.substring(0, responseCollections401_description_break));
- $("#examples-Collections-updateCollection-description-401").html(responseCollections401_description.substring(responseCollections401_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipById-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipById-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
}
</script>
- <ul id="responses-detail-Collections-updateCollection-401" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getRelationshipById-401" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Collections-updateCollection-401-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipById-401-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Collections-updateCollection-401-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Collections-updateCollection-401-schema">
- <div id="responses-Collections-updateCollection-schema-401" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipById-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipById-401-schema">
+ <div id="responses-EntitiesAndRelationships-getRelationshipById-schema-401" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Collections-updateCollection-401-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Collections-updateCollection-schema-401');
+ $('#responses-EntitiesAndRelationships-getRelationshipById-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getRelationshipById-schema-401');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Collections-updateCollection-401-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getRelationshipById-401-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Collections-updateCollection-title-403"></h3>
- <p id="examples-Collections-updateCollection-description-403" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getRelationshipById-title-403"></h3>
+ <p id="examples-EntitiesAndRelationships-getRelationshipById-description-403" class="marked"></p>
<script>
- var responseCollections403_description = `Forbidden`;
- var responseCollections403_description_break = responseCollections403_description.indexOf('\n');
- if (responseCollections403_description_break == -1) {
- $("#examples-Collections-updateCollection-title-403").text("Status: 403 - " + responseCollections403_description);
+ var responseEntitiesAndRelationships403_description = `Forbidden`;
+ var responseEntitiesAndRelationships403_description_break = responseEntitiesAndRelationships403_description.indexOf('\n');
+ if (responseEntitiesAndRelationships403_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getRelationshipById-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
} else {
- $("#examples-Collections-updateCollection-title-403").text("Status: 403 - " + responseCollections403_description.substring(0, responseCollections403_description_break));
- $("#examples-Collections-updateCollection-description-403").html(responseCollections403_description.substring(responseCollections403_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipById-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipById-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
}
</script>
- <ul id="responses-detail-Collections-updateCollection-403" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getRelationshipById-403" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Collections-updateCollection-403-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipById-403-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Collections-updateCollection-403-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Collections-updateCollection-403-schema">
- <div id="responses-Collections-updateCollection-schema-403" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipById-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipById-403-schema">
+ <div id="responses-EntitiesAndRelationships-getRelationshipById-schema-403" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Collections-updateCollection-403-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Collections-updateCollection-schema-403');
+ $('#responses-EntitiesAndRelationships-getRelationshipById-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getRelationshipById-schema-403');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Collections-updateCollection-403-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getRelationshipById-403-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Collections-updateCollection-title-409"></h3>
- <p id="examples-Collections-updateCollection-description-409" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getRelationshipById-title-404"></h3>
+ <p id="examples-EntitiesAndRelationships-getRelationshipById-description-404" class="marked"></p>
<script>
- var responseCollections409_description = `Conflict`;
- var responseCollections409_description_break = responseCollections409_description.indexOf('\n');
- if (responseCollections409_description_break == -1) {
- $("#examples-Collections-updateCollection-title-409").text("Status: 409 - " + responseCollections409_description);
+ var responseEntitiesAndRelationships404_description = `Not Found`;
+ var responseEntitiesAndRelationships404_description_break = responseEntitiesAndRelationships404_description.indexOf('\n');
+ if (responseEntitiesAndRelationships404_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getRelationshipById-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description);
} else {
- $("#examples-Collections-updateCollection-title-409").text("Status: 409 - " + responseCollections409_description.substring(0, responseCollections409_description_break));
- $("#examples-Collections-updateCollection-description-409").html(responseCollections409_description.substring(responseCollections409_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipById-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description.substring(0, responseEntitiesAndRelationships404_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipById-description-404").html(responseEntitiesAndRelationships404_description.substring(responseEntitiesAndRelationships404_description_break));
}
</script>
- <ul id="responses-detail-Collections-updateCollection-409" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getRelationshipById-404" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Collections-updateCollection-409-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipById-404-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Collections-updateCollection-409-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Collections-updateCollection-409-schema">
- <div id="responses-Collections-updateCollection-schema-409" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipById-404-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipById-404-schema">
+ <div id="responses-EntitiesAndRelationships-getRelationshipById-schema-404" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Conflict",
+ "description" : "Not Found",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
- "status" : "409'",
- "title" : "Conflicting request",
- "details" : "The request cannot be processed as the resource is in use."
+ "status" : "404",
+ "title" : "Resource Not Found",
+ "details" : "The requested resource is not found"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Collections-updateCollection-409-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Collections-updateCollection-schema-409');
+ $('#responses-EntitiesAndRelationships-getRelationshipById-404-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getRelationshipById-schema-404');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Collections-updateCollection-409-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getRelationshipById-404-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Collections-updateCollection-title-500"></h3>
- <p id="examples-Collections-updateCollection-description-500" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getRelationshipById-title-500"></h3>
+ <p id="examples-EntitiesAndRelationships-getRelationshipById-description-500" class="marked"></p>
<script>
- var responseCollections500_description = `Internal Server Error`;
- var responseCollections500_description_break = responseCollections500_description.indexOf('\n');
- if (responseCollections500_description_break == -1) {
- $("#examples-Collections-updateCollection-title-500").text("Status: 500 - " + responseCollections500_description);
+ var responseEntitiesAndRelationships500_description = `Internal Server Error`;
+ var responseEntitiesAndRelationships500_description_break = responseEntitiesAndRelationships500_description.indexOf('\n');
+ if (responseEntitiesAndRelationships500_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getRelationshipById-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description);
} else {
- $("#examples-Collections-updateCollection-title-500").text("Status: 500 - " + responseCollections500_description.substring(0, responseCollections500_description_break));
- $("#examples-Collections-updateCollection-description-500").html(responseCollections500_description.substring(responseCollections500_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipById-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description.substring(0, responseEntitiesAndRelationships500_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipById-description-500").html(responseEntitiesAndRelationships500_description.substring(responseEntitiesAndRelationships500_description_break));
}
</script>
- <ul id="responses-detail-Collections-updateCollection-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getRelationshipById-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Collections-updateCollection-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipById-500-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Collections-updateCollection-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Collections-updateCollection-500-schema">
- <div id="responses-Collections-updateCollection-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipById-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipById-500-schema">
+ <div id="responses-EntitiesAndRelationships-getRelationshipById-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Collections-updateCollection-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Collections-updateCollection-schema-500');
+ $('#responses-EntitiesAndRelationships-getRelationshipById-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getRelationshipById-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Collections-updateCollection-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getRelationshipById-500-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- </section>
- <section id="api-Decorators">
- <h1>Decorators</h1>
- <div id="api-Decorators-updateDecorator">
- <article id="api-Decorators-updateDecorator-0" data-group="User" data-name="updateDecorator" data-version="0">
+ <div id="api-EntitiesAndRelationships-getRelationshipsByType">
+ <article id="api-EntitiesAndRelationships-getRelationshipsByType-0" data-group="User" data-name="getRelationshipsByType" data-version="0">
<div class="pull-left">
- <h1>updateDecorator</h1>
- <p>Update entities and/or relationships with decorator(s).</p>
+ <h1>getRelationshipsByType</h1>
+ <p>Get topology relationships of a specific relationship type name.</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Update entities and/or relationships with decorator(s).</p>
+ <p class="marked">Get topology relationships of a specific relationship type name.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/decorators</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains/{domainName}/relationship-types/{relationshipTypeName}/relationships</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
- <li class="active"><a href="#examples-Decorators-updateDecorator-0-curl">Curl</a></li>
- <li class=""><a href="#examples-Decorators-updateDecorator-0-java">Java</a></li>
- <li class=""><a href="#examples-Decorators-updateDecorator-0-dart">Dart</a></li>
- <li class=""><a href="#examples-Decorators-updateDecorator-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-Decorators-updateDecorator-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-Decorators-updateDecorator-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-Decorators-updateDecorator-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-Decorators-updateDecorator-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-Decorators-updateDecorator-0-csharp">C#</a></li>
- <li class=""><a href="#examples-Decorators-updateDecorator-0-php">PHP</a></li>
- <li class=""><a href="#examples-Decorators-updateDecorator-0-perl">Perl</a></li>
- <li class=""><a href="#examples-Decorators-updateDecorator-0-python">Python</a></li>
- <li class=""><a href="#examples-Decorators-updateDecorator-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-java">Java</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-php">PHP</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-python">Python</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-Decorators-updateDecorator-0-curl">
- <pre class="prettyprint"><code class="language-bsh">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" ]
-}'
-</code></pre>
+ <div class="tab-pane active" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-curl">
+ <pre class="prettyprint"><code class="language-bsh">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"
+</code></pre>
</div>
- <div class="tab-pane" id="examples-Decorators-updateDecorator-0-java">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-java">
<pre class="prettyprint"><code class="language-java">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();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Decorators-updateDecorator-0-dart">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-dart">
<pre class="prettyprint"><code class="language-dart">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');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Decorators-updateDecorator-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.DecoratorsApi;
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-android">
+ <pre class="prettyprint"><code class="language-java">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();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-Decorators-updateDecorator-0-groovy">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-Decorators-updateDecorator-0-objc">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// 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);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Decorators-updateDecorator-0-javascript">
- <pre class="prettyprint"><code class="language-js">var TopologyAndInventoryApi = require('topology_and_inventory_api');
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-javascript">
+ <pre class="prettyprint"><code class="language-js">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);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-Decorators-updateDecorator-0-angular">
+ <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-Decorators-updateDecorator-0-csharp">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
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 );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Decorators-updateDecorator-0-php">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-php">
<pre class="prettyprint"><code class="language-php"><?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;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-Decorators-updateDecorator-0-perl">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-perl">
<pre class="prettyprint"><code class="language-perl">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";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-Decorators-updateDecorator-0-python">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import openapi_client
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)</code></pre>
+ print("Exception when calling EntitiesAndRelationshipsApi->getRelationshipsByType: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-Decorators-updateDecorator-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate DecoratorsApi;
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-rust">
+ <pre class="prettyprint"><code class="language-rust">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);
}
<h2>Parameters</h2>
-
- <div class="methodsubtabletitle">Header parameters</div>
+ <div class="methodsubtabletitle">Path parameters</div>
<table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">Accept*</td>
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">domainName*</td>
<td>
- <div id="d2e199_updateDecorator_accept">
+ <div id="d2e199_getRelationshipsByType_domainName">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
String
</span>
+ <div class="inner description marked">
+domain name
+ </div>
</div>
<div class="inner required">
Required
</td>
</tr>
- <tr><td style="width:150px;">Content-Type*</td>
+ <tr><td style="width:150px;">relationshipTypeName*</td>
<td>
- <div id="d2e199_updateDecorator_contentType">
+ <div id="d2e199_getRelationshipsByType_relationshipTypeName">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
</table>
- <div class="methodsubtabletitle">Body parameters</div>
+ <div class="methodsubtabletitle">Header parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
- <tr><td style="width:150px;">decorator <span style="color:red;">*</span></td>
+ <tr><td style="width:150px;">Accept*</td>
<td>
-<p class="marked"></p>
-<script>
-$(document).ready(function() {
- var schemaWrapper = {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/Decorator"
- },
- "examples" : {
- "decorator" : {
- "$ref" : "#/components/examples/DecoratorExample"
- }
- }
- }
- },
- "required" : true
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
- var view = new JSONSchemaView(schema,2,{isBodyParam: true});
- var result = $('#d2e199_updateDecorator_decorator');
- result.empty();
- result.append(view.render());
-});
-</script>
-<div id="d2e199_updateDecorator_decorator"></div>
+ <div id="d2e199_getRelationshipsByType_accept">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
</td>
</tr>
+ <div class="methodsubtabletitle">Query parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">targetFilter</td>
+<td>
+
+
+ <div id="d2e199_getRelationshipsByType_targetFilter">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ <div class="inner description marked">
+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.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">scopeFilter</td>
+<td>
+
+
+ <div id="d2e199_getRelationshipsByType_scopeFilter">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ <div class="inner description marked">
+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.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">offset</td>
+<td>
+
+
+ <div id="d2e199_getRelationshipsByType_offset">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ Integer
+ </span>
+
+ <div class="inner description marked">
+Pagination offset.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">limit</td>
+<td>
+
+
+ <div id="d2e199_getRelationshipsByType_limit">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ Integer
+ </span>
+
+ <div class="inner description marked">
+Result limiter.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ </table>
+
<h2>Responses</h2>
- <h3 id="examples-Decorators-updateDecorator-title-204"></h3>
- <p id="examples-Decorators-updateDecorator-description-204" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getRelationshipsByType-title-200"></h3>
+ <p id="examples-EntitiesAndRelationships-getRelationshipsByType-description-200" class="marked"></p>
<script>
- var responseDecorators204_description = `No Content`;
- var responseDecorators204_description_break = responseDecorators204_description.indexOf('\n');
- if (responseDecorators204_description_break == -1) {
- $("#examples-Decorators-updateDecorator-title-204").text("Status: 204 - " + responseDecorators204_description);
+ var responseEntitiesAndRelationships200_description = `OK`;
+ var responseEntitiesAndRelationships200_description_break = responseEntitiesAndRelationships200_description.indexOf('\n');
+ if (responseEntitiesAndRelationships200_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
} else {
- $("#examples-Decorators-updateDecorator-title-204").text("Status: 204 - " + responseDecorators204_description.substring(0, responseDecorators204_description_break));
- $("#examples-Decorators-updateDecorator-description-204").html(responseDecorators204_description.substring(responseDecorators204_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
}
</script>
- <ul id="responses-detail-Decorators-updateDecorator-204" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getRelationshipsByType-200" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipsByType-200-schema">Schema</a>
+ </li>
+
+
</ul>
- <div class="tab-content" id="responses-Decorators-updateDecorator-204-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Decorators-updateDecorator-204-schema">
- <div id="responses-Decorators-updateDecorator-schema-204" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipsByType-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipsByType-200-schema">
+ <div id="responses-EntitiesAndRelationships-getRelationshipsByType-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "No Content",
- "content" : { }
+ "description" : "OK",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RelationshipsResponseMessage"
+ },
+ "examples" : {
+ "relationships" : {
+ "$ref" : "#/components/examples/RelationshipsResponseExample"
+ }
+ }
+ }
+ }
};
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Decorators-updateDecorator-204-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Decorators-updateDecorator-schema-204');
+ $('#responses-EntitiesAndRelationships-getRelationshipsByType-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getRelationshipsByType-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Decorators-updateDecorator-204-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getRelationshipsByType-200-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Decorators-updateDecorator-title-400"></h3>
- <p id="examples-Decorators-updateDecorator-description-400" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getRelationshipsByType-title-400"></h3>
+ <p id="examples-EntitiesAndRelationships-getRelationshipsByType-description-400" class="marked"></p>
<script>
- var responseDecorators400_description = `Bad Request`;
- var responseDecorators400_description_break = responseDecorators400_description.indexOf('\n');
- if (responseDecorators400_description_break == -1) {
- $("#examples-Decorators-updateDecorator-title-400").text("Status: 400 - " + responseDecorators400_description);
+ var responseEntitiesAndRelationships400_description = `Bad Request`;
+ var responseEntitiesAndRelationships400_description_break = responseEntitiesAndRelationships400_description.indexOf('\n');
+ if (responseEntitiesAndRelationships400_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
} else {
- $("#examples-Decorators-updateDecorator-title-400").text("Status: 400 - " + responseDecorators400_description.substring(0, responseDecorators400_description_break));
- $("#examples-Decorators-updateDecorator-description-400").html(responseDecorators400_description.substring(responseDecorators400_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
}
</script>
- <ul id="responses-detail-Decorators-updateDecorator-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getRelationshipsByType-400" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Decorators-updateDecorator-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipsByType-400-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Decorators-updateDecorator-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Decorators-updateDecorator-400-schema">
- <div id="responses-Decorators-updateDecorator-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipsByType-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipsByType-400-schema">
+ <div id="responses-EntitiesAndRelationships-getRelationshipsByType-schema-400" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Decorators-updateDecorator-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Decorators-updateDecorator-schema-400');
+ $('#responses-EntitiesAndRelationships-getRelationshipsByType-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getRelationshipsByType-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Decorators-updateDecorator-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getRelationshipsByType-400-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Decorators-updateDecorator-title-401"></h3>
- <p id="examples-Decorators-updateDecorator-description-401" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getRelationshipsByType-title-401"></h3>
+ <p id="examples-EntitiesAndRelationships-getRelationshipsByType-description-401" class="marked"></p>
<script>
- var responseDecorators401_description = `Unauthorized`;
- var responseDecorators401_description_break = responseDecorators401_description.indexOf('\n');
- if (responseDecorators401_description_break == -1) {
- $("#examples-Decorators-updateDecorator-title-401").text("Status: 401 - " + responseDecorators401_description);
+ var responseEntitiesAndRelationships401_description = `Unauthorized`;
+ var responseEntitiesAndRelationships401_description_break = responseEntitiesAndRelationships401_description.indexOf('\n');
+ if (responseEntitiesAndRelationships401_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
} else {
- $("#examples-Decorators-updateDecorator-title-401").text("Status: 401 - " + responseDecorators401_description.substring(0, responseDecorators401_description_break));
- $("#examples-Decorators-updateDecorator-description-401").html(responseDecorators401_description.substring(responseDecorators401_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
}
</script>
- <ul id="responses-detail-Decorators-updateDecorator-401" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getRelationshipsByType-401" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Decorators-updateDecorator-401-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipsByType-401-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Decorators-updateDecorator-401-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Decorators-updateDecorator-401-schema">
- <div id="responses-Decorators-updateDecorator-schema-401" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipsByType-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipsByType-401-schema">
+ <div id="responses-EntitiesAndRelationships-getRelationshipsByType-schema-401" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Decorators-updateDecorator-401-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Decorators-updateDecorator-schema-401');
+ $('#responses-EntitiesAndRelationships-getRelationshipsByType-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getRelationshipsByType-schema-401');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Decorators-updateDecorator-401-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getRelationshipsByType-401-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Decorators-updateDecorator-title-403"></h3>
- <p id="examples-Decorators-updateDecorator-description-403" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getRelationshipsByType-title-403"></h3>
+ <p id="examples-EntitiesAndRelationships-getRelationshipsByType-description-403" class="marked"></p>
<script>
- var responseDecorators403_description = `Forbidden`;
- var responseDecorators403_description_break = responseDecorators403_description.indexOf('\n');
- if (responseDecorators403_description_break == -1) {
- $("#examples-Decorators-updateDecorator-title-403").text("Status: 403 - " + responseDecorators403_description);
+ var responseEntitiesAndRelationships403_description = `Forbidden`;
+ var responseEntitiesAndRelationships403_description_break = responseEntitiesAndRelationships403_description.indexOf('\n');
+ if (responseEntitiesAndRelationships403_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
} else {
- $("#examples-Decorators-updateDecorator-title-403").text("Status: 403 - " + responseDecorators403_description.substring(0, responseDecorators403_description_break));
- $("#examples-Decorators-updateDecorator-description-403").html(responseDecorators403_description.substring(responseDecorators403_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
}
</script>
- <ul id="responses-detail-Decorators-updateDecorator-403" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getRelationshipsByType-403" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Decorators-updateDecorator-403-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipsByType-403-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Decorators-updateDecorator-403-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Decorators-updateDecorator-403-schema">
- <div id="responses-Decorators-updateDecorator-schema-403" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipsByType-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipsByType-403-schema">
+ <div id="responses-EntitiesAndRelationships-getRelationshipsByType-schema-403" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Decorators-updateDecorator-403-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Decorators-updateDecorator-schema-403');
+ $('#responses-EntitiesAndRelationships-getRelationshipsByType-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getRelationshipsByType-schema-403');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Decorators-updateDecorator-403-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getRelationshipsByType-403-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Decorators-updateDecorator-title-409"></h3>
- <p id="examples-Decorators-updateDecorator-description-409" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getRelationshipsByType-title-500"></h3>
+ <p id="examples-EntitiesAndRelationships-getRelationshipsByType-description-500" class="marked"></p>
<script>
- var responseDecorators409_description = `Conflict`;
- var responseDecorators409_description_break = responseDecorators409_description.indexOf('\n');
- if (responseDecorators409_description_break == -1) {
- $("#examples-Decorators-updateDecorator-title-409").text("Status: 409 - " + responseDecorators409_description);
- } else {
- $("#examples-Decorators-updateDecorator-title-409").text("Status: 409 - " + responseDecorators409_description.substring(0, responseDecorators409_description_break));
- $("#examples-Decorators-updateDecorator-description-409").html(responseDecorators409_description.substring(responseDecorators409_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-Decorators-updateDecorator-409" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-Decorators-updateDecorator-409-schema">Schema</a>
- </li>
-
-
-
-
- </ul>
-
-
- <div class="tab-content" id="responses-Decorators-updateDecorator-409-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Decorators-updateDecorator-409-schema">
- <div id="responses-Decorators-updateDecorator-schema-409" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "Conflict",
- "content" : {
- "application/problem+json" : {
- "schema" : {
- "$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "409'",
- "title" : "Conflicting request",
- "details" : "The request cannot be processed as the resource is in use."
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema == null) {
- return;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- if (schema.properties != null) {
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- }
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-Decorators-updateDecorator-409-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Decorators-updateDecorator-schema-409');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-Decorators-updateDecorator-409-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- <h3 id="examples-Decorators-updateDecorator-title-500"></h3>
- <p id="examples-Decorators-updateDecorator-description-500" class="marked"></p>
- <script>
- var responseDecorators500_description = `Internal Server Error`;
- var responseDecorators500_description_break = responseDecorators500_description.indexOf('\n');
- if (responseDecorators500_description_break == -1) {
- $("#examples-Decorators-updateDecorator-title-500").text("Status: 500 - " + responseDecorators500_description);
+ var responseEntitiesAndRelationships500_description = `Internal Server Error`;
+ var responseEntitiesAndRelationships500_description_break = responseEntitiesAndRelationships500_description.indexOf('\n');
+ if (responseEntitiesAndRelationships500_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description);
} else {
- $("#examples-Decorators-updateDecorator-title-500").text("Status: 500 - " + responseDecorators500_description.substring(0, responseDecorators500_description_break));
- $("#examples-Decorators-updateDecorator-description-500").html(responseDecorators500_description.substring(responseDecorators500_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description.substring(0, responseEntitiesAndRelationships500_description_break));
+ $("#examples-EntitiesAndRelationships-getRelationshipsByType-description-500").html(responseEntitiesAndRelationships500_description.substring(responseEntitiesAndRelationships500_description_break));
}
</script>
- <ul id="responses-detail-Decorators-updateDecorator-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getRelationshipsByType-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Decorators-updateDecorator-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipsByType-500-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Decorators-updateDecorator-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Decorators-updateDecorator-500-schema">
- <div id="responses-Decorators-updateDecorator-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipsByType-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipsByType-500-schema">
+ <div id="responses-EntitiesAndRelationships-getRelationshipsByType-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Decorators-updateDecorator-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Decorators-updateDecorator-schema-500');
+ $('#responses-EntitiesAndRelationships-getRelationshipsByType-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getRelationshipsByType-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Decorators-updateDecorator-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getRelationshipsByType-500-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- </section>
- <section id="api-EntitiesAndRelationships">
- <h1>EntitiesAndRelationships</h1>
- <div id="api-EntitiesAndRelationships-getAllDomains">
- <article id="api-EntitiesAndRelationships-getAllDomains-0" data-group="User" data-name="getAllDomains" data-version="0">
+ <div id="api-EntitiesAndRelationships-getTopologyByEntityTypeName">
+ <article id="api-EntitiesAndRelationships-getTopologyByEntityTypeName-0" data-group="User" data-name="getTopologyByEntityTypeName" data-version="0">
<div class="pull-left">
- <h1>getAllDomains</h1>
- <p>Get all the available topology domains.</p>
+ <h1>getTopologyByEntityTypeName</h1>
+ <p>Get all topology entities of a specific entity type.</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Get all the available topology domains.</p>
+ <p class="marked">Get all topology entities of a specific entity type.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains/{domainName}/entity-types/{entityTypeName}/entities</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
- <li class="active"><a href="#examples-EntitiesAndRelationships-getAllDomains-0-curl">Curl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-java">Java</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-dart">Dart</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-csharp">C#</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-php">PHP</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-perl">Perl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-python">Python</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllDomains-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-java">Java</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-php">PHP</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-python">Python</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-EntitiesAndRelationships-getAllDomains-0-curl">
+ <div class="tab-pane active" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X GET \
-H "Accept: application/json,application/problem+json" \
- "https://localhost/topology-inventory/v1alpha11/domains?offset=56&limit=56"
+ "https://localhost/topology-inventory/v1alpha11/domains/{domainName}/entity-types/{entityTypeName}/entities?targetFilter=/attributes(nCI,nRPCI)&scopeFilter=/attributes[@nRTAC=310]&offset=56&limit=56"
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-java">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-java">
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
// 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 {
- Domains result = apiInstance.getAllDomains(accept, offset, limit);
+ 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#getAllDomains");
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyByEntityTypeName");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-dart">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-dart">
<pre class="prettyprint"><code class="language-dart">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.getAllDomains(accept, offset, limit);
+ final result = await api_instance.getTopologyByEntityTypeName(accept, domainName, entityTypeName, targetFilter, scopeFilter, offset, limit);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->getAllDomains: $e\n');
+ print('Exception when calling DefaultApi->getTopologyByEntityTypeName: $e\n');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-android">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-android">
<pre class="prettyprint"><code class="language-java">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 {
- Domains result = apiInstance.getAllDomains(accept, offset, limit);
+ 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#getAllDomains");
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyByEntityTypeName");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-groovy">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-objc">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// 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 the available topology domains.
-[apiInstance getAllDomainsWith:accept
+// 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: ^(Domains output, NSError* error) {
+ completionHandler: ^(EntitiesResponseMessage output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-javascript">
- <pre class="prettyprint"><code class="language-js">var TopologyAndInventoryApi = require('topology_and_inventory_api');
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-javascript">
+ <pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
-var api = new TopologyAndInventoryApi.EntitiesAndRelationshipsApi()
+var api = new TopologyExposureAndInventoryApi.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.
};
console.log('API called successfully. Returned data: ' + data);
}
};
-api.getAllDomains(accept, opts, callback);
+api.getTopologyByEntityTypeName(accept, domainName, entityTypeName, opts, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-angular">
+ <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-csharp">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class getAllDomainsExample
+ 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 the available topology domains.
- Domains result = apiInstance.getAllDomains(accept, offset, limit);
+ // 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.getAllDomains: " + e.Message );
+ Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getTopologyByEntityTypeName: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-php">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-php">
<pre class="prettyprint"><code class="language-php"><?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->getAllDomains($accept, $offset, $limit);
+ $result = $api_instance->getTopologyByEntityTypeName($accept, $domainName, $entityTypeName, $targetFilter, $scopeFilter, $offset, $limit);
print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling EntitiesAndRelationshipsApi->getAllDomains: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling EntitiesAndRelationshipsApi->getTopologyByEntityTypeName: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-perl">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-perl">
<pre class="prettyprint"><code class="language-perl">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->getAllDomains(accept => $accept, offset => $offset, limit => $limit);
+ 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->getAllDomains: $@\n";
+ warn "Exception when calling EntitiesAndRelationshipsApi->getTopologyByEntityTypeName: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-python">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import openapi_client
# 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 the available topology domains.
- api_response = api_instance.get_all_domains(accept, offset=offset, limit=limit)
+ # 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->getAllDomains: %s\n" % e)</code></pre>
+ print("Exception when calling EntitiesAndRelationshipsApi->getTopologyByEntityTypeName: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllDomains-0-rust">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-rust">
<pre class="prettyprint"><code class="language-rust">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.getAllDomains(accept, offset, limit, &context).wait();
+ let result = client.getTopologyByEntityTypeName(accept, domainName, entityTypeName, targetFilter, scopeFilter, offset, limit, &context).wait();
println!("{:?}", result);
}
<h2>Parameters</h2>
-
- <div class="methodsubtabletitle">Header parameters</div>
+ <div class="methodsubtabletitle">Path parameters</div>
<table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">domainName*</td>
+<td>
+
+
+ <div id="d2e199_getTopologyByEntityTypeName_domainName">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ <div class="inner description marked">
+domain name
+ </div>
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">entityTypeName*</td>
+<td>
+
+
+ <div id="d2e199_getTopologyByEntityTypeName_entityTypeName">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ </div>
+ <div class="inner required">
+ Required
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ </table>
+
+ <div class="methodsubtabletitle">Header parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">Accept*</td>
<td>
- <div id="d2e199_getAllDomains_accept">
+ <div id="d2e199_getTopologyByEntityTypeName_accept">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
<th width="150px">Name</th>
<th>Description</th>
</tr>
+ <tr><td style="width:150px;">targetFilter</td>
+<td>
+
+
+ <div id="d2e199_getTopologyByEntityTypeName_targetFilter">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ <div class="inner description marked">
+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.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
+ <tr><td style="width:150px;">scopeFilter</td>
+<td>
+
+
+ <div id="d2e199_getTopologyByEntityTypeName_scopeFilter">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ String
+ </span>
+
+ <div class="inner description marked">
+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.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+
<tr><td style="width:150px;">offset</td>
<td>
- <div id="d2e199_getAllDomains_offset">
+ <div id="d2e199_getTopologyByEntityTypeName_offset">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
<td>
- <div id="d2e199_getAllDomains_limit">
+ <div id="d2e199_getTopologyByEntityTypeName_limit">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
</table>
<h2>Responses</h2>
- <h3 id="examples-EntitiesAndRelationships-getAllDomains-title-200"></h3>
- <p id="examples-EntitiesAndRelationships-getAllDomains-description-200" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-200"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-200" class="marked"></p>
<script>
var responseEntitiesAndRelationships200_description = `OK`;
var responseEntitiesAndRelationships200_description_break = responseEntitiesAndRelationships200_description.indexOf('\n');
if (responseEntitiesAndRelationships200_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getAllDomains-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
} else {
- $("#examples-EntitiesAndRelationships-getAllDomains-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
- $("#examples-EntitiesAndRelationships-getAllDomains-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getAllDomains-200" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyByEntityTypeName-200" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllDomains-200-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-200-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getAllDomains-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllDomains-200-schema">
- <div id="responses-EntitiesAndRelationships-getAllDomains-schema-200" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-200-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/Domains"
+ "$ref" : "#/components/schemas/EntitiesResponseMessage"
},
"examples" : {
- "domains" : {
- "$ref" : "#/components/examples/DomainsResponseExample"
+ "entities" : {
+ "$ref" : "#/components/examples/EntitiesResponseExample"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getAllDomains-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getAllDomains-schema-200');
+ $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getAllDomains-200-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getTopologyByEntityTypeName-200-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getAllDomains-title-400"></h3>
- <p id="examples-EntitiesAndRelationships-getAllDomains-description-400" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-400"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-400" class="marked"></p>
<script>
var responseEntitiesAndRelationships400_description = `Bad Request`;
var responseEntitiesAndRelationships400_description_break = responseEntitiesAndRelationships400_description.indexOf('\n');
if (responseEntitiesAndRelationships400_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getAllDomains-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
} else {
- $("#examples-EntitiesAndRelationships-getAllDomains-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
- $("#examples-EntitiesAndRelationships-getAllDomains-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getAllDomains-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyByEntityTypeName-400" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllDomains-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-400-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getAllDomains-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllDomains-400-schema">
- <div id="responses-EntitiesAndRelationships-getAllDomains-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-400-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-400" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getAllDomains-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getAllDomains-schema-400');
+ $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getAllDomains-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getTopologyByEntityTypeName-400-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getAllDomains-title-401"></h3>
- <p id="examples-EntitiesAndRelationships-getAllDomains-description-401" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-401"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-401" class="marked"></p>
<script>
var responseEntitiesAndRelationships401_description = `Unauthorized`;
var responseEntitiesAndRelationships401_description_break = responseEntitiesAndRelationships401_description.indexOf('\n');
if (responseEntitiesAndRelationships401_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getAllDomains-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
} else {
- $("#examples-EntitiesAndRelationships-getAllDomains-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
- $("#examples-EntitiesAndRelationships-getAllDomains-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getAllDomains-401" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyByEntityTypeName-401" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllDomains-401-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-401-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getAllDomains-401-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllDomains-401-schema">
- <div id="responses-EntitiesAndRelationships-getAllDomains-schema-401" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-401-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-401" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getAllDomains-401-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getAllDomains-schema-401');
+ $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-401');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getAllDomains-401-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getTopologyByEntityTypeName-401-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getAllDomains-title-403"></h3>
- <p id="examples-EntitiesAndRelationships-getAllDomains-description-403" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-403"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-403" class="marked"></p>
<script>
var responseEntitiesAndRelationships403_description = `Forbidden`;
var responseEntitiesAndRelationships403_description_break = responseEntitiesAndRelationships403_description.indexOf('\n');
if (responseEntitiesAndRelationships403_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getAllDomains-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
} else {
- $("#examples-EntitiesAndRelationships-getAllDomains-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
- $("#examples-EntitiesAndRelationships-getAllDomains-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getAllDomains-403" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyByEntityTypeName-403" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllDomains-403-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-403-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getAllDomains-403-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllDomains-403-schema">
- <div id="responses-EntitiesAndRelationships-getAllDomains-schema-403" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-403-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-403" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getAllDomains-403-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getAllDomains-schema-403');
+ $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-403');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getAllDomains-403-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getTopologyByEntityTypeName-403-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getAllDomains-title-500"></h3>
- <p id="examples-EntitiesAndRelationships-getAllDomains-description-500" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-500"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-500" class="marked"></p>
<script>
var responseEntitiesAndRelationships500_description = `Internal Server Error`;
var responseEntitiesAndRelationships500_description_break = responseEntitiesAndRelationships500_description.indexOf('\n');
if (responseEntitiesAndRelationships500_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getAllDomains-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description);
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description);
} else {
- $("#examples-EntitiesAndRelationships-getAllDomains-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description.substring(0, responseEntitiesAndRelationships500_description_break));
- $("#examples-EntitiesAndRelationships-getAllDomains-description-500").html(responseEntitiesAndRelationships500_description.substring(responseEntitiesAndRelationships500_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description.substring(0, responseEntitiesAndRelationships500_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-500").html(responseEntitiesAndRelationships500_description.substring(responseEntitiesAndRelationships500_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getAllDomains-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyByEntityTypeName-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllDomains-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-500-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getAllDomains-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllDomains-500-schema">
- <div id="responses-EntitiesAndRelationships-getAllDomains-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-500-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getAllDomains-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getAllDomains-schema-500');
+ $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getAllDomains-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getTopologyByEntityTypeName-500-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- <div id="api-EntitiesAndRelationships-getAllRelationshipsForEntityId">
- <article id="api-EntitiesAndRelationships-getAllRelationshipsForEntityId-0" data-group="User" data-name="getAllRelationshipsForEntityId" data-version="0">
+ <div id="api-EntitiesAndRelationships-getTopologyById">
+ <article id="api-EntitiesAndRelationships-getTopologyById-0" data-group="User" data-name="getTopologyById" data-version="0">
<div class="pull-left">
- <h1>getAllRelationshipsForEntityId</h1>
- <p>Get all relationships for entity type name with specified id. Specified id represents the entity instance.</p>
+ <h1>getTopologyById</h1>
+ <p>Get topology for entity type name with specified id. Specified id represents the entity instance.</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Get all relationships for entity type name with specified id. Specified id represents the entity instance.</p>
+ <p class="marked">Get topology for entity type name with specified id. Specified id represents the entity instance.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains/{domainName}/entity-types/{entityTypeName}/entities/{entityId}/relationships</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains/{domainName}/entity-types/{entityTypeName}/entities/{entityId}</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
- <li class="active"><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-curl">Curl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-java">Java</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-dart">Dart</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-csharp">C#</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-php">PHP</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-perl">Perl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-python">Python</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-EntitiesAndRelationships-getTopologyById-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-java">Java</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-php">PHP</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-python">Python</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-curl">
+ <div class="tab-pane active" id="examples-EntitiesAndRelationships-getTopologyById-0-curl">
<pre class="prettyprint"><code class="language-bsh">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"
+ -H "Accept: application/yang.data+json,application/problem+json" \
+ "https://localhost/topology-inventory/v1alpha11/domains/{domainName}/entity-types/{entityTypeName}/entities/{entityId}"
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-java">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-java">
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
// Create an instance of the API class
EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
- String accept = application/json; // String |
+ String accept = application/yang.data+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);
+ Object result = apiInstance.getTopologyById(accept, domainName, entityTypeName, entityId);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling EntitiesAndRelationshipsApi#getAllRelationshipsForEntityId");
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyById");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-dart">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-dart">
<pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
final api_instance = DefaultApi();
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);
+ final result = await api_instance.getTopologyById(accept, domainName, entityTypeName, entityId);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->getAllRelationshipsForEntityId: $e\n');
+ print('Exception when calling DefaultApi->getTopologyById: $e\n');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-android">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-android">
<pre class="prettyprint"><code class="language-java">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 accept = application/yang.data+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);
+ Object result = apiInstance.getTopologyById(accept, domainName, entityTypeName, entityId);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling EntitiesAndRelationshipsApi#getAllRelationshipsForEntityId");
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyById");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-groovy">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-objc">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// Create an instance of the API class
EntitiesAndRelationshipsApi *apiInstance = [[EntitiesAndRelationshipsApi alloc] init];
-String *accept = application/json; // (default to application/json)
+String *accept = application/yang.data+json; // (default to application/yang.data+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
+// Get topology for entity type name with specified id. Specified id represents the entity instance.
+[apiInstance getTopologyByIdWith:accept
domainName:domainName
entityTypeName:entityTypeName
entityId:entityId
- offset:offset
- limit:limit
- completionHandler: ^(RelationshipsResponseMessage output, NSError* error) {
+ completionHandler: ^(Object output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-javascript">
- <pre class="prettyprint"><code class="language-js">var TopologyAndInventoryApi = require('topology_and_inventory_api');
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-javascript">
+ <pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
-var api = new TopologyAndInventoryApi.EntitiesAndRelationshipsApi()
-var accept = application/json; // {String}
+var api = new TopologyExposureAndInventoryApi.EntitiesAndRelationshipsApi()
+var accept = application/yang.data+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.log('API called successfully. Returned data: ' + data);
}
};
-api.getAllRelationshipsForEntityId(accept, domainName, entityTypeName, entityId, opts, callback);
+api.getTopologyById(accept, domainName, entityTypeName, entityId, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-angular">
+ <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-csharp">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class getAllRelationshipsForEntityIdExample
+ 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 accept = application/yang.data+json; // String | (default to application/yang.data+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);
+ // 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.getAllRelationshipsForEntityId: " + e.Message );
+ Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getTopologyById: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-php">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-php">
<pre class="prettyprint"><code class="language-php"><?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 |
+$accept = application/yang.data+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);
+ $result = $api_instance->getTopologyById($accept, $domainName, $entityTypeName, $entityId);
print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling EntitiesAndRelationshipsApi->getAllRelationshipsForEntityId: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling EntitiesAndRelationshipsApi->getTopologyById: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-perl">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-perl">
<pre class="prettyprint"><code class="language-perl">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 $accept = application/yang.data+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);
+ my $result = $api_instance->getTopologyById(accept => $accept, domainName => $domainName, entityTypeName => $entityTypeName, entityId => $entityId);
print Dumper($result);
};
if ($@) {
- warn "Exception when calling EntitiesAndRelationshipsApi->getAllRelationshipsForEntityId: $@\n";
+ warn "Exception when calling EntitiesAndRelationshipsApi->getTopologyById: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-python">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import openapi_client
# Create an instance of the API class
api_instance = openapi_client.EntitiesAndRelationshipsApi()
-accept = application/json # String | (default to application/json)
+accept = application/yang.data+json # String | (default to application/yang.data+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)
+ # 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->getAllRelationshipsForEntityId: %s\n" % e)</code></pre>
+ print("Exception when calling EntitiesAndRelationshipsApi->getTopologyById: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-0-rust">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-rust">
<pre class="prettyprint"><code class="language-rust">extern crate EntitiesAndRelationshipsApi;
pub fn main() {
- let accept = application/json; // String
+ let accept = application/yang.data+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();
+ let result = client.getTopologyById(accept, domainName, entityTypeName, entityId, &context).wait();
println!("{:?}", result);
}
<td>
- <div id="d2e199_getAllRelationshipsForEntityId_domainName">
+ <div id="d2e199_getTopologyById_domainName">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
<td>
- <div id="d2e199_getAllRelationshipsForEntityId_entityTypeName">
+ <div id="d2e199_getTopologyById_entityTypeName">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
<td>
- <div id="d2e199_getAllRelationshipsForEntityId_entityId">
+ <div id="d2e199_getTopologyById_entityId">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
<td>
- <div id="d2e199_getAllRelationshipsForEntityId_accept">
+ <div id="d2e199_getTopologyById_accept">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
- <div class="methodsubtabletitle">Query parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">offset</td>
-<td>
-
-
- <div id="d2e199_getAllRelationshipsForEntityId_offset">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- Integer
- </span>
-
- <div class="inner description marked">
-Pagination offset.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- <tr><td style="width:150px;">limit</td>
-<td>
-
-
- <div id="d2e199_getAllRelationshipsForEntityId_limit">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- Integer
- </span>
-
- <div class="inner description marked">
-Result limiter.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- </table>
<h2>Responses</h2>
- <h3 id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-200"></h3>
- <p id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-200" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyById-title-200"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyById-description-200" class="marked"></p>
<script>
var responseEntitiesAndRelationships200_description = `OK`;
var responseEntitiesAndRelationships200_description_break = responseEntitiesAndRelationships200_description.indexOf('\n');
if (responseEntitiesAndRelationships200_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
+ $("#examples-EntitiesAndRelationships-getTopologyById-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
} else {
- $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
- $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyById-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyById-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getAllRelationshipsForEntityId-200" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyById-200" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-200-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyById-200-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-200-schema">
- <div id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-200" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyById-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyById-200-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyById-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "OK",
"content" : {
- "application/json" : {
+ "application/yang.data+json" : {
"schema" : {
- "$ref" : "#/components/schemas/RelationshipsResponseMessage"
+ "type" : "object",
+ "description" : "Refer to yang model for schema definition"
},
"examples" : {
- "relationships" : {
- "$ref" : "#/components/examples/RelationshipsResponseExample"
+ "entity" : {
+ "$ref" : "#/components/examples/EntityResponseExample"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-200');
+ $('#responses-EntitiesAndRelationships-getTopologyById-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyById-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-200-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getTopologyById-200-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-400"></h3>
- <p id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-400" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyById-title-400"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyById-description-400" class="marked"></p>
<script>
var responseEntitiesAndRelationships400_description = `Bad Request`;
var responseEntitiesAndRelationships400_description_break = responseEntitiesAndRelationships400_description.indexOf('\n');
if (responseEntitiesAndRelationships400_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
+ $("#examples-EntitiesAndRelationships-getTopologyById-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
} else {
- $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
- $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyById-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyById-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getAllRelationshipsForEntityId-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyById-400" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyById-400-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-400-schema">
- <div id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyById-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyById-400-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyById-schema-400" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-400');
+ $('#responses-EntitiesAndRelationships-getTopologyById-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyById-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getTopologyById-400-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-401"></h3>
- <p id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-401" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyById-title-401"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyById-description-401" class="marked"></p>
<script>
var responseEntitiesAndRelationships401_description = `Unauthorized`;
var responseEntitiesAndRelationships401_description_break = responseEntitiesAndRelationships401_description.indexOf('\n');
if (responseEntitiesAndRelationships401_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
+ $("#examples-EntitiesAndRelationships-getTopologyById-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
} else {
- $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
- $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyById-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyById-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getAllRelationshipsForEntityId-401" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyById-401" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-401-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyById-401-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-401-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-401-schema">
- <div id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-401" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyById-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyById-401-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyById-schema-401" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-401-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-401');
+ $('#responses-EntitiesAndRelationships-getTopologyById-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyById-schema-401');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-401-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getTopologyById-401-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-403"></h3>
- <p id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-403" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyById-title-403"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyById-description-403" class="marked"></p>
<script>
var responseEntitiesAndRelationships403_description = `Forbidden`;
var responseEntitiesAndRelationships403_description_break = responseEntitiesAndRelationships403_description.indexOf('\n');
if (responseEntitiesAndRelationships403_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
+ $("#examples-EntitiesAndRelationships-getTopologyById-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
} else {
- $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
- $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyById-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyById-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getAllRelationshipsForEntityId-403" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyById-403" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-403-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyById-403-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-403-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-403-schema">
- <div id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-403" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyById-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyById-403-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyById-schema-403" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-403-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-403');
+ $('#responses-EntitiesAndRelationships-getTopologyById-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyById-schema-403');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-403-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getTopologyById-403-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-404"></h3>
- <p id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-404" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyById-title-404"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyById-description-404" class="marked"></p>
<script>
var responseEntitiesAndRelationships404_description = `Not Found`;
var responseEntitiesAndRelationships404_description_break = responseEntitiesAndRelationships404_description.indexOf('\n');
if (responseEntitiesAndRelationships404_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description);
+ $("#examples-EntitiesAndRelationships-getTopologyById-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description);
} else {
- $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description.substring(0, responseEntitiesAndRelationships404_description_break));
- $("#examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-404").html(responseEntitiesAndRelationships404_description.substring(responseEntitiesAndRelationships404_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyById-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description.substring(0, responseEntitiesAndRelationships404_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyById-description-404").html(responseEntitiesAndRelationships404_description.substring(responseEntitiesAndRelationships404_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getAllRelationshipsForEntityId-404" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyById-404" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-404-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyById-404-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-404-schema">
- <div id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-404" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyById-404-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyById-404-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyById-schema-404" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-404');
+ $('#responses-EntitiesAndRelationships-getTopologyById-404-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyById-schema-404');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-404-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getTopologyById-404-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-title-500"></h3>
- <p id="examples-EntitiesAndRelationships-getAllRelationshipsForEntityId-description-500" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyById-title-500"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyById-description-500" class="marked"></p>
<script>
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);
+ $("#examples-EntitiesAndRelationships-getTopologyById-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));
+ $("#examples-EntitiesAndRelationships-getTopologyById-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description.substring(0, responseEntitiesAndRelationships500_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyById-description-500").html(responseEntitiesAndRelationships500_description.substring(responseEntitiesAndRelationships500_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getAllRelationshipsForEntityId-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyById-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyById-500-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-500-schema">
- <div id="responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyById-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyById-500-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyById-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-schema-500');
+ $('#responses-EntitiesAndRelationships-getTopologyById-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyById-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getAllRelationshipsForEntityId-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getTopologyById-500-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- <div id="api-EntitiesAndRelationships-getEntitiesByDomain">
- <article id="api-EntitiesAndRelationships-getEntitiesByDomain-0" data-group="User" data-name="getEntitiesByDomain" data-version="0">
+ <div id="api-EntitiesAndRelationships-getTopologyEntityTypes">
+ <article id="api-EntitiesAndRelationships-getTopologyEntityTypes-0" data-group="User" data-name="getTopologyEntityTypes" data-version="0">
<div class="pull-left">
- <h1>getEntitiesByDomain</h1>
- <p>Get entities by domain</p>
+ <h1>getTopologyEntityTypes</h1>
+ <p>Get all the available topology entity types in domain name.</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Get topology entities by domain, using specified targetFilter as mandatory query parameter.</p>
+ <p class="marked">Get all the available topology entity types in domain name.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains/{domainName}/entities</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains/{domainName}/entity-types</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
- <li class="active"><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-curl">Curl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-java">Java</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-dart">Dart</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-csharp">C#</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-php">PHP</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-perl">Perl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-python">Python</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getEntitiesByDomain-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-java">Java</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-php">PHP</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-python">Python</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-curl">
+ <div class="tab-pane active" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-curl">
<pre class="prettyprint"><code class="language-bsh">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"
+ "https://localhost/topology-inventory/v1alpha11/domains/{domainName}/entity-types?offset=56&limit=56"
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-java">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-java">
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
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);
+ EntityTypes result = apiInstance.getTopologyEntityTypes(accept, domainName, offset, limit);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling EntitiesAndRelationshipsApi#getEntitiesByDomain");
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyEntityTypes");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-dart">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-dart">
<pre class="prettyprint"><code class="language-dart">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);
+ final result = await api_instance.getTopologyEntityTypes(accept, domainName, offset, limit);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->getEntitiesByDomain: $e\n');
+ print('Exception when calling DefaultApi->getTopologyEntityTypes: $e\n');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-android">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-android">
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.EntitiesAndRelationshipsApi;
public class EntitiesAndRelationshipsApiExample {
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);
+ EntityTypes result = apiInstance.getTopologyEntityTypes(accept, domainName, offset, limit);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling EntitiesAndRelationshipsApi#getEntitiesByDomain");
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyEntityTypes");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-groovy">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-objc">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// 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
+// Get all the available topology entity types in domain name.
+[apiInstance getTopologyEntityTypesWith:accept
domainName:domainName
- targetFilter:targetFilter
- scopeFilter:scopeFilter
offset:offset
limit:limit
- completionHandler: ^(EntitiesResponseMessage output, NSError* error) {
+ completionHandler: ^(EntityTypes output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-javascript">
- <pre class="prettyprint"><code class="language-js">var TopologyAndInventoryApi = require('topology_and_inventory_api');
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-javascript">
+ <pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
-var api = new TopologyAndInventoryApi.EntitiesAndRelationshipsApi()
+var api = new TopologyExposureAndInventoryApi.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.
};
console.log('API called successfully. Returned data: ' + data);
}
};
-api.getEntitiesByDomain(accept, domainName, opts, callback);
+api.getTopologyEntityTypes(accept, domainName, opts, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-angular">
+ <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-csharp">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class getEntitiesByDomainExample
+ public class getTopologyEntityTypesExample
{
public void main()
{
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);
+ // 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.getEntitiesByDomain: " + e.Message );
+ Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getTopologyEntityTypes: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-php">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-php">
<pre class="prettyprint"><code class="language-php"><?php
require_once(__DIR__ . '/vendor/autoload.php');
$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);
+ $result = $api_instance->getTopologyEntityTypes($accept, $domainName, $offset, $limit);
print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling EntitiesAndRelationshipsApi->getEntitiesByDomain: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling EntitiesAndRelationshipsApi->getTopologyEntityTypes: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-perl">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntitiesAndRelationshipsApi;
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);
+ my $result = $api_instance->getTopologyEntityTypes(accept => $accept, domainName => $domainName, offset => $offset, limit => $limit);
print Dumper($result);
};
if ($@) {
- warn "Exception when calling EntitiesAndRelationshipsApi->getEntitiesByDomain: $@\n";
+ warn "Exception when calling EntitiesAndRelationshipsApi->getTopologyEntityTypes: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-python">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import openapi_client
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)
+ # 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->getEntitiesByDomain: %s\n" % e)</code></pre>
+ print("Exception when calling EntitiesAndRelationshipsApi->getTopologyEntityTypes: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getEntitiesByDomain-0-rust">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-rust">
<pre class="prettyprint"><code class="language-rust">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();
+ let result = client.getTopologyEntityTypes(accept, domainName, offset, limit, &context).wait();
println!("{:?}", result);
}
<td>
- <div id="d2e199_getEntitiesByDomain_domainName">
+ <div id="d2e199_getTopologyEntityTypes_domainName">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
<td>
- <div id="d2e199_getEntitiesByDomain_accept">
+ <div id="d2e199_getTopologyEntityTypes_accept">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
<th width="150px">Name</th>
<th>Description</th>
</tr>
- <tr><td style="width:150px;">targetFilter</td>
-<td>
-
-
- <div id="d2e199_getEntitiesByDomain_targetFilter">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
-
- <div class="inner description marked">
-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.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- <tr><td style="width:150px;">scopeFilter</td>
-<td>
-
-
- <div id="d2e199_getEntitiesByDomain_scopeFilter">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
-
- <div class="inner description marked">
-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.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
-
<tr><td style="width:150px;">offset</td>
<td>
- <div id="d2e199_getEntitiesByDomain_offset">
+ <div id="d2e199_getTopologyEntityTypes_offset">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
<td>
- <div id="d2e199_getEntitiesByDomain_limit">
+ <div id="d2e199_getTopologyEntityTypes_limit">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
</table>
<h2>Responses</h2>
- <h3 id="examples-EntitiesAndRelationships-getEntitiesByDomain-title-200"></h3>
- <p id="examples-EntitiesAndRelationships-getEntitiesByDomain-description-200" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyEntityTypes-title-200"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyEntityTypes-description-200" class="marked"></p>
<script>
var responseEntitiesAndRelationships200_description = `OK`;
var responseEntitiesAndRelationships200_description_break = responseEntitiesAndRelationships200_description.indexOf('\n');
if (responseEntitiesAndRelationships200_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
} else {
- $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
- $("#examples-EntitiesAndRelationships-getEntitiesByDomain-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getEntitiesByDomain-200" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyEntityTypes-200" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getEntitiesByDomain-200-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyEntityTypes-200-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getEntitiesByDomain-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getEntitiesByDomain-200-schema">
- <div id="responses-EntitiesAndRelationships-getEntitiesByDomain-schema-200" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-200-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/EntitiesResponseMessage"
+ "$ref" : "#/components/schemas/EntityTypes"
},
"examples" : {
- "entities" : {
- "$ref" : "#/components/examples/EntitiesResponseExample"
+ "entityTypes" : {
+ "$ref" : "#/components/examples/EntityTypesResponseExample"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getEntitiesByDomain-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getEntitiesByDomain-schema-200');
+ $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getEntitiesByDomain-200-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getTopologyEntityTypes-200-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getEntitiesByDomain-title-400"></h3>
- <p id="examples-EntitiesAndRelationships-getEntitiesByDomain-description-400" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyEntityTypes-title-400"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyEntityTypes-description-400" class="marked"></p>
<script>
var responseEntitiesAndRelationships400_description = `Bad Request`;
var responseEntitiesAndRelationships400_description_break = responseEntitiesAndRelationships400_description.indexOf('\n');
if (responseEntitiesAndRelationships400_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
} else {
- $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
- $("#examples-EntitiesAndRelationships-getEntitiesByDomain-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getEntitiesByDomain-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyEntityTypes-400" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getEntitiesByDomain-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyEntityTypes-400-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getEntitiesByDomain-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getEntitiesByDomain-400-schema">
- <div id="responses-EntitiesAndRelationships-getEntitiesByDomain-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-400-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-400" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getEntitiesByDomain-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getEntitiesByDomain-schema-400');
+ $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getEntitiesByDomain-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getTopologyEntityTypes-400-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getEntitiesByDomain-title-401"></h3>
- <p id="examples-EntitiesAndRelationships-getEntitiesByDomain-description-401" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyEntityTypes-title-401"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyEntityTypes-description-401" class="marked"></p>
<script>
var responseEntitiesAndRelationships401_description = `Unauthorized`;
var responseEntitiesAndRelationships401_description_break = responseEntitiesAndRelationships401_description.indexOf('\n');
if (responseEntitiesAndRelationships401_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
} else {
- $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
- $("#examples-EntitiesAndRelationships-getEntitiesByDomain-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getEntitiesByDomain-401" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyEntityTypes-401" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getEntitiesByDomain-401-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyEntityTypes-401-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getEntitiesByDomain-401-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getEntitiesByDomain-401-schema">
- <div id="responses-EntitiesAndRelationships-getEntitiesByDomain-schema-401" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-401-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-401" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getEntitiesByDomain-401-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getEntitiesByDomain-schema-401');
+ $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-401');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getEntitiesByDomain-401-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getTopologyEntityTypes-401-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getEntitiesByDomain-title-403"></h3>
- <p id="examples-EntitiesAndRelationships-getEntitiesByDomain-description-403" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyEntityTypes-title-403"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyEntityTypes-description-403" class="marked"></p>
<script>
var responseEntitiesAndRelationships403_description = `Forbidden`;
var responseEntitiesAndRelationships403_description_break = responseEntitiesAndRelationships403_description.indexOf('\n');
if (responseEntitiesAndRelationships403_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
} else {
- $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
- $("#examples-EntitiesAndRelationships-getEntitiesByDomain-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getEntitiesByDomain-403" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyEntityTypes-403" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getEntitiesByDomain-403-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyEntityTypes-403-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getEntitiesByDomain-403-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getEntitiesByDomain-403-schema">
- <div id="responses-EntitiesAndRelationships-getEntitiesByDomain-schema-403" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-403-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-403" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getEntitiesByDomain-403-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getEntitiesByDomain-schema-403');
+ $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-403');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getEntitiesByDomain-403-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getTopologyEntityTypes-403-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getEntitiesByDomain-title-500"></h3>
- <p id="examples-EntitiesAndRelationships-getEntitiesByDomain-description-500" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyEntityTypes-title-500"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyEntityTypes-description-500" class="marked"></p>
<script>
var responseEntitiesAndRelationships500_description = `Internal Server Error`;
var responseEntitiesAndRelationships500_description_break = responseEntitiesAndRelationships500_description.indexOf('\n');
if (responseEntitiesAndRelationships500_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description);
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description);
} else {
- $("#examples-EntitiesAndRelationships-getEntitiesByDomain-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description.substring(0, responseEntitiesAndRelationships500_description_break));
- $("#examples-EntitiesAndRelationships-getEntitiesByDomain-description-500").html(responseEntitiesAndRelationships500_description.substring(responseEntitiesAndRelationships500_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description.substring(0, responseEntitiesAndRelationships500_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-description-500").html(responseEntitiesAndRelationships500_description.substring(responseEntitiesAndRelationships500_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getEntitiesByDomain-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyEntityTypes-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getEntitiesByDomain-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyEntityTypes-500-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getEntitiesByDomain-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getEntitiesByDomain-500-schema">
- <div id="responses-EntitiesAndRelationships-getEntitiesByDomain-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-500-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getEntitiesByDomain-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getEntitiesByDomain-schema-500');
+ $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getEntitiesByDomain-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getTopologyEntityTypes-500-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- <div id="api-EntitiesAndRelationships-getRelationshipById">
- <article id="api-EntitiesAndRelationships-getRelationshipById-0" data-group="User" data-name="getRelationshipById" data-version="0">
+ <div id="api-EntitiesAndRelationships-getTopologyRelationshipTypes">
+ <article id="api-EntitiesAndRelationships-getTopologyRelationshipTypes-0" data-group="User" data-name="getTopologyRelationshipTypes" data-version="0">
<div class="pull-left">
- <h1>getRelationshipById</h1>
- <p>Get relationship with specified id. Specified id represents the relationship instance.</p>
+ <h1>getTopologyRelationshipTypes</h1>
+ <p>Get all the available topology relationship types.</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Get relationship with specified id. Specified id represents the relationship instance.</p>
+ <p class="marked">Get all the available topology relationship types.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains/{domainName}/relationship-types/{relationshipTypeName}/relationships/{relationshipId}</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains/{domainName}/relationship-types</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
- <li class="active"><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-curl">Curl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-java">Java</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-dart">Dart</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-csharp">C#</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-php">PHP</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-perl">Perl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-python">Python</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipById-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-java">Java</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-php">PHP</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-python">Python</a></li>
+ <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-EntitiesAndRelationships-getRelationshipById-0-curl">
+ <div class="tab-pane active" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X GET \
- -H "Accept: application/yang.data+json,application/problem+json" \
- "https://localhost/topology-inventory/v1alpha11/domains/{domainName}/relationship-types/{relationshipTypeName}/relationships/{relationshipId}"
+ -H "Accept: application/json,application/problem+json" \
+ "https://localhost/topology-inventory/v1alpha11/domains/{domainName}/relationship-types?offset=56&limit=56"
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-java">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-java">
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
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 |
+ Integer offset = 56; // Integer | Pagination offset.
+ Integer limit = 56; // Integer | Result limiter.
try {
- Object result = apiInstance.getRelationshipById(accept, domainName, relationshipTypeName, relationshipId);
+ RelationshipTypes result = apiInstance.getTopologyRelationshipTypes(accept, domainName, offset, limit);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling EntitiesAndRelationshipsApi#getRelationshipById");
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyRelationshipTypes");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-dart">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-dart">
<pre class="prettyprint"><code class="language-dart">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 |
+final Integer offset = new Integer(); // Integer | Pagination offset.
+final Integer limit = new Integer(); // Integer | Result limiter.
try {
- final result = await api_instance.getRelationshipById(accept, domainName, relationshipTypeName, relationshipId);
+ final result = await api_instance.getTopologyRelationshipTypes(accept, domainName, offset, limit);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->getRelationshipById: $e\n');
+ print('Exception when calling DefaultApi->getTopologyRelationshipTypes: $e\n');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-android">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-android">
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.EntitiesAndRelationshipsApi;
public class EntitiesAndRelationshipsApiExample {
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 |
+ Integer offset = 56; // Integer | Pagination offset.
+ Integer limit = 56; // Integer | Result limiter.
try {
- Object result = apiInstance.getRelationshipById(accept, domainName, relationshipTypeName, relationshipId);
+ RelationshipTypes result = apiInstance.getTopologyRelationshipTypes(accept, domainName, offset, limit);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling EntitiesAndRelationshipsApi#getRelationshipById");
+ System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyRelationshipTypes");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-groovy">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-objc">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// 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)
+Integer *offset = 56; // Pagination offset. (optional) (default to 0)
+Integer *limit = 56; // Result limiter. (optional) (default to 500)
-// Get relationship with specified id. Specified id represents the relationship instance.
-[apiInstance getRelationshipByIdWith:accept
+// Get all the available topology relationship types.
+[apiInstance getTopologyRelationshipTypesWith:accept
domainName:domainName
- relationshipTypeName:relationshipTypeName
- relationshipId:relationshipId
- completionHandler: ^(Object output, NSError* error) {
+ offset:offset
+ limit:limit
+ completionHandler: ^(RelationshipTypes output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-javascript">
- <pre class="prettyprint"><code class="language-js">var TopologyAndInventoryApi = require('topology_and_inventory_api');
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-javascript">
+ <pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
-var api = new TopologyAndInventoryApi.EntitiesAndRelationshipsApi()
+var api = new TopologyExposureAndInventoryApi.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 opts = {
+ 'offset': 56, // {Integer} Pagination offset.
+ 'limit': 56 // {Integer} Result limiter.
+};
var callback = function(error, data, response) {
if (error) {
console.log('API called successfully. Returned data: ' + data);
}
};
-api.getRelationshipById(accept, domainName, relationshipTypeName, relationshipId, callback);
+api.getTopologyRelationshipTypes(accept, domainName, opts, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-angular">
+ <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-csharp">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class getRelationshipByIdExample
+ public class getTopologyRelationshipTypesExample
{
public void main()
{
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)
+ var offset = 56; // Integer | Pagination offset. (optional) (default to 0)
+ var limit = 56; // Integer | Result limiter. (optional) (default to 500)
try {
- // Get relationship with specified id. Specified id represents the relationship instance.
- Object result = apiInstance.getRelationshipById(accept, domainName, relationshipTypeName, relationshipId);
+ // 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.getRelationshipById: " + e.Message );
+ Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getTopologyRelationshipTypes: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-php">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-php">
<pre class="prettyprint"><code class="language-php"><?php
require_once(__DIR__ . '/vendor/autoload.php');
$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 |
+$offset = 56; // Integer | Pagination offset.
+$limit = 56; // Integer | Result limiter.
try {
- $result = $api_instance->getRelationshipById($accept, $domainName, $relationshipTypeName, $relationshipId);
+ $result = $api_instance->getTopologyRelationshipTypes($accept, $domainName, $offset, $limit);
print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling EntitiesAndRelationshipsApi->getRelationshipById: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling EntitiesAndRelationshipsApi->getTopologyRelationshipTypes: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-perl">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntitiesAndRelationshipsApi;
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 |
+my $offset = 56; # Integer | Pagination offset.
+my $limit = 56; # Integer | Result limiter.
eval {
- my $result = $api_instance->getRelationshipById(accept => $accept, domainName => $domainName, relationshipTypeName => $relationshipTypeName, relationshipId => $relationshipId);
+ my $result = $api_instance->getTopologyRelationshipTypes(accept => $accept, domainName => $domainName, offset => $offset, limit => $limit);
print Dumper($result);
};
if ($@) {
- warn "Exception when calling EntitiesAndRelationshipsApi->getRelationshipById: $@\n";
+ warn "Exception when calling EntitiesAndRelationshipsApi->getTopologyRelationshipTypes: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-python">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import openapi_client
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)
+offset = 56 # Integer | Pagination offset. (optional) (default to 0)
+limit = 56 # Integer | Result limiter. (optional) (default to 500)
try:
- # Get relationship with specified id. Specified id represents the relationship instance.
- api_response = api_instance.get_relationship_by_id(accept, domainName, relationshipTypeName, relationshipId)
+ # 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->getRelationshipById: %s\n" % e)</code></pre>
+ print("Exception when calling EntitiesAndRelationshipsApi->getTopologyRelationshipTypes: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipById-0-rust">
+ <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-rust">
<pre class="prettyprint"><code class="language-rust">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 offset = 56; // Integer
+ let limit = 56; // Integer
let mut context = EntitiesAndRelationshipsApi::Context::default();
- let result = client.getRelationshipById(accept, domainName, relationshipTypeName, relationshipId, &context).wait();
+ let result = client.getTopologyRelationshipTypes(accept, domainName, offset, limit, &context).wait();
println!("{:?}", result);
}
<td>
- <div id="d2e199_getRelationshipById_domainName">
+ <div id="d2e199_getTopologyRelationshipTypes_domainName">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
</td>
</tr>
- <tr><td style="width:150px;">relationshipTypeName*</td>
+ </table>
+
+ <div class="methodsubtabletitle">Header parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">Accept*</td>
<td>
- <div id="d2e199_getRelationshipById_relationshipTypeName">
+ <div id="d2e199_getTopologyRelationshipTypes_accept">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
</td>
</tr>
- <tr><td style="width:150px;">relationshipId*</td>
+ </table>
+
+
+
+ <div class="methodsubtabletitle">Query parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">offset</td>
<td>
- <div id="d2e199_getRelationshipById_relationshipId">
+ <div id="d2e199_getTopologyRelationshipTypes_offset">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
- String
+ Integer
</span>
+ <div class="inner description marked">
+Pagination offset.
+ </div>
</div>
- <div class="inner required">
- Required
- </div>
</div>
</div>
</td>
</tr>
- </table>
-
- <div class="methodsubtabletitle">Header parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">Accept*</td>
+ <tr><td style="width:150px;">limit</td>
<td>
- <div id="d2e199_getRelationshipById_accept">
+ <div id="d2e199_getTopologyRelationshipTypes_limit">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
- String
+ Integer
</span>
+ <div class="inner description marked">
+Result limiter.
+ </div>
</div>
- <div class="inner required">
- Required
- </div>
</div>
</div>
</td>
</table>
-
-
-
<h2>Responses</h2>
- <h3 id="examples-EntitiesAndRelationships-getRelationshipById-title-200"></h3>
- <p id="examples-EntitiesAndRelationships-getRelationshipById-description-200" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-200"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-200" class="marked"></p>
<script>
var responseEntitiesAndRelationships200_description = `OK`;
var responseEntitiesAndRelationships200_description_break = responseEntitiesAndRelationships200_description.indexOf('\n');
if (responseEntitiesAndRelationships200_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getRelationshipById-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
} else {
- $("#examples-EntitiesAndRelationships-getRelationshipById-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
- $("#examples-EntitiesAndRelationships-getRelationshipById-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getRelationshipById-200" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyRelationshipTypes-200" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipById-200-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-200-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipById-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipById-200-schema">
- <div id="responses-EntitiesAndRelationships-getRelationshipById-schema-200" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-200-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "OK",
"content" : {
- "application/yang.data+json" : {
+ "application/json" : {
"schema" : {
- "type" : "object",
- "description" : "Refer to yang model for schema definition"
+ "$ref" : "#/components/schemas/RelationshipTypes"
},
"examples" : {
- "relationship" : {
- "$ref" : "#/components/examples/RelationshipResponseExample"
+ "relationshipTypes" : {
+ "$ref" : "#/components/examples/RelationshipTypesResponseExample"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getRelationshipById-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getRelationshipById-schema-200');
+ $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getRelationshipById-200-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getTopologyRelationshipTypes-200-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getRelationshipById-title-400"></h3>
- <p id="examples-EntitiesAndRelationships-getRelationshipById-description-400" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-400"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-400" class="marked"></p>
<script>
var responseEntitiesAndRelationships400_description = `Bad Request`;
var responseEntitiesAndRelationships400_description_break = responseEntitiesAndRelationships400_description.indexOf('\n');
if (responseEntitiesAndRelationships400_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getRelationshipById-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
} else {
- $("#examples-EntitiesAndRelationships-getRelationshipById-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
- $("#examples-EntitiesAndRelationships-getRelationshipById-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getRelationshipById-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyRelationshipTypes-400" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipById-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-400-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipById-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipById-400-schema">
- <div id="responses-EntitiesAndRelationships-getRelationshipById-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-400-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-400" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getRelationshipById-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getRelationshipById-schema-400');
+ $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getRelationshipById-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getTopologyRelationshipTypes-400-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getRelationshipById-title-401"></h3>
- <p id="examples-EntitiesAndRelationships-getRelationshipById-description-401" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-401"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-401" class="marked"></p>
<script>
var responseEntitiesAndRelationships401_description = `Unauthorized`;
var responseEntitiesAndRelationships401_description_break = responseEntitiesAndRelationships401_description.indexOf('\n');
if (responseEntitiesAndRelationships401_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getRelationshipById-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
} else {
- $("#examples-EntitiesAndRelationships-getRelationshipById-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
- $("#examples-EntitiesAndRelationships-getRelationshipById-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getRelationshipById-401" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyRelationshipTypes-401" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipById-401-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-401-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipById-401-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipById-401-schema">
- <div id="responses-EntitiesAndRelationships-getRelationshipById-schema-401" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-401-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-401" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getRelationshipById-401-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getRelationshipById-schema-401');
+ $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-401');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getRelationshipById-401-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getTopologyRelationshipTypes-401-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getRelationshipById-title-403"></h3>
- <p id="examples-EntitiesAndRelationships-getRelationshipById-description-403" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-403"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-403" class="marked"></p>
<script>
var responseEntitiesAndRelationships403_description = `Forbidden`;
var responseEntitiesAndRelationships403_description_break = responseEntitiesAndRelationships403_description.indexOf('\n');
if (responseEntitiesAndRelationships403_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getRelationshipById-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
} else {
- $("#examples-EntitiesAndRelationships-getRelationshipById-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
- $("#examples-EntitiesAndRelationships-getRelationshipById-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getRelationshipById-403" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyRelationshipTypes-403" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipById-403-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-403-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipById-403-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipById-403-schema">
- <div id="responses-EntitiesAndRelationships-getRelationshipById-schema-403" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-403-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-403" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getRelationshipById-403-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getRelationshipById-schema-403');
+ $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-403');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getRelationshipById-403-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getTopologyRelationshipTypes-403-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getRelationshipById-title-404"></h3>
- <p id="examples-EntitiesAndRelationships-getRelationshipById-description-404" class="marked"></p>
+ <h3 id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-500"></h3>
+ <p id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-500" class="marked"></p>
<script>
- var responseEntitiesAndRelationships404_description = `Not Found`;
- var responseEntitiesAndRelationships404_description_break = responseEntitiesAndRelationships404_description.indexOf('\n');
- if (responseEntitiesAndRelationships404_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getRelationshipById-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description);
+ var responseEntitiesAndRelationships500_description = `Internal Server Error`;
+ var responseEntitiesAndRelationships500_description_break = responseEntitiesAndRelationships500_description.indexOf('\n');
+ if (responseEntitiesAndRelationships500_description_break == -1) {
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description);
} else {
- $("#examples-EntitiesAndRelationships-getRelationshipById-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description.substring(0, responseEntitiesAndRelationships404_description_break));
- $("#examples-EntitiesAndRelationships-getRelationshipById-description-404").html(responseEntitiesAndRelationships404_description.substring(responseEntitiesAndRelationships404_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description.substring(0, responseEntitiesAndRelationships500_description_break));
+ $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-500").html(responseEntitiesAndRelationships500_description.substring(responseEntitiesAndRelationships500_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getRelationshipById-404" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-EntitiesAndRelationships-getTopologyRelationshipTypes-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipById-404-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-500-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipById-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipById-404-schema">
- <div id="responses-EntitiesAndRelationships-getRelationshipById-schema-404" class="exampleStyle">
+ <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-500-schema">
+ <div id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Not Found",
+ "description" : "Internal Server Error",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
- "status" : "404",
- "title" : "Resource Not Found",
- "details" : "The requested resource is not found"
+ "status" : "500",
+ "title" : "Internal Server Error",
+ "details" : "Internal Server Error occurred"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getRelationshipById-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getRelationshipById-schema-404');
+ $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getRelationshipById-404-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- <h3 id="examples-EntitiesAndRelationships-getRelationshipById-title-500"></h3>
- <p id="examples-EntitiesAndRelationships-getRelationshipById-description-500" class="marked"></p>
- <script>
- var responseEntitiesAndRelationships500_description = `Internal Server Error`;
- var responseEntitiesAndRelationships500_description_break = responseEntitiesAndRelationships500_description.indexOf('\n');
- if (responseEntitiesAndRelationships500_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getRelationshipById-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description);
- } else {
- $("#examples-EntitiesAndRelationships-getRelationshipById-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description.substring(0, responseEntitiesAndRelationships500_description_break));
- $("#examples-EntitiesAndRelationships-getRelationshipById-description-500").html(responseEntitiesAndRelationships500_description.substring(responseEntitiesAndRelationships500_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-EntitiesAndRelationships-getRelationshipById-500" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipById-500-schema">Schema</a>
- </li>
-
-
-
-
- </ul>
-
-
- <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipById-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipById-500-schema">
- <div id="responses-EntitiesAndRelationships-getRelationshipById-schema-500" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "Internal Server Error",
- "content" : {
- "application/problem+json" : {
- "schema" : {
- "$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "500",
- "title" : "Internal Server Error",
- "details" : "Internal Server Error occurred"
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema == null) {
- return;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- if (schema.properties != null) {
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- }
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getRelationshipById-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getRelationshipById-schema-500');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-EntitiesAndRelationships-getRelationshipById-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-EntitiesAndRelationships-getTopologyRelationshipTypes-500-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- <div id="api-EntitiesAndRelationships-getRelationshipsByType">
- <article id="api-EntitiesAndRelationships-getRelationshipsByType-0" data-group="User" data-name="getRelationshipsByType" data-version="0">
+ </section>
+ <section id="api-Schemas">
+ <h1>Schemas</h1>
+ <div id="api-Schemas-createSchema">
+ <article id="api-Schemas-createSchema-0" data-group="User" data-name="createSchema" data-version="0">
<div class="pull-left">
- <h1>getRelationshipsByType</h1>
- <p>Get topology relationships of a specific relationship type name.</p>
+ <h1>createSchema</h1>
+ <p>Create a new schema.</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Get topology relationships of a specific relationship type name.</p>
+ <p class="marked">Create a new schema. The request body shall contain the schema in YANG format.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains/{domainName}/relationship-types/{relationshipTypeName}/relationships</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/schemas</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
- <li class="active"><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-curl">Curl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-java">Java</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-dart">Dart</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-csharp">C#</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-php">PHP</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-perl">Perl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-python">Python</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getRelationshipsByType-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-Schemas-createSchema-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-Schemas-createSchema-0-java">Java</a></li>
+ <li class=""><a href="#examples-Schemas-createSchema-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-Schemas-createSchema-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-Schemas-createSchema-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-Schemas-createSchema-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-Schemas-createSchema-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-Schemas-createSchema-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-Schemas-createSchema-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-Schemas-createSchema-0-php">PHP</a></li>
+ <li class=""><a href="#examples-Schemas-createSchema-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-Schemas-createSchema-0-python">Python</a></li>
+ <li class=""><a href="#examples-Schemas-createSchema-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-curl">
- <pre class="prettyprint"><code class="language-bsh">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"
+ <div class="tab-pane active" id="examples-Schemas-createSchema-0-curl">
+ <pre class="prettyprint"><code class="language-bsh">curl -X POST \
+ -H "Accept: application/problem+json" \
+ -H "Content-Type: multipart/form-data" \
+ "https://localhost/topology-inventory/v1alpha11/schemas"
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-java">
+ <div class="tab-pane" id="examples-Schemas-createSchema-0-java">
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
-import org.openapitools.client.api.EntitiesAndRelationshipsApi;
+import org.openapitools.client.api.SchemasApi;
import java.io.File;
import java.util.*;
-public class EntitiesAndRelationshipsApiExample {
+public class SchemasApiExample {
public static void main(String[] args) {
// Create an instance of the API class
- EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
+ SchemasApi apiInstance = new SchemasApi();
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.
+ String contentType = multipart/form-data; // String |
+ File file = BINARY_DATA_HERE; // File | multipartFile
try {
- RelationshipsResponseMessage result = apiInstance.getRelationshipsByType(accept, domainName, relationshipTypeName, targetFilter, scopeFilter, offset, limit);
- System.out.println(result);
+ apiInstance.createSchema(accept, contentType, file);
} catch (ApiException e) {
- System.err.println("Exception when calling EntitiesAndRelationshipsApi#getRelationshipsByType");
+ System.err.println("Exception when calling SchemasApi#createSchema");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-dart">
+ <div class="tab-pane" id="examples-Schemas-createSchema-0-dart">
<pre class="prettyprint"><code class="language-dart">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.
+final String contentType = new String(); // String |
+final File file = new File(); // File | multipartFile
try {
- final result = await api_instance.getRelationshipsByType(accept, domainName, relationshipTypeName, targetFilter, scopeFilter, offset, limit);
+ final result = await api_instance.createSchema(accept, contentType, file);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->getRelationshipsByType: $e\n');
+ print('Exception when calling DefaultApi->createSchema: $e\n');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.EntitiesAndRelationshipsApi;
+ <div class="tab-pane" id="examples-Schemas-createSchema-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.SchemasApi;
-public class EntitiesAndRelationshipsApiExample {
+public class SchemasApiExample {
public static void main(String[] args) {
- EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
+ SchemasApi apiInstance = new SchemasApi();
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.
+ String contentType = multipart/form-data; // String |
+ File file = BINARY_DATA_HERE; // File | multipartFile
try {
- RelationshipsResponseMessage result = apiInstance.getRelationshipsByType(accept, domainName, relationshipTypeName, targetFilter, scopeFilter, offset, limit);
- System.out.println(result);
+ apiInstance.createSchema(accept, contentType, file);
} catch (ApiException e) {
- System.err.println("Exception when calling EntitiesAndRelationshipsApi#getRelationshipsByType");
+ System.err.println("Exception when calling SchemasApi#createSchema");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-groovy">
+ <div class="tab-pane" id="examples-Schemas-createSchema-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-objc">
+ <div class="tab-pane" id="examples-Schemas-createSchema-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// Create an instance of the API class
-EntitiesAndRelationshipsApi *apiInstance = [[EntitiesAndRelationshipsApi alloc] init];
+SchemasApi *apiInstance = [[SchemasApi 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)
+String *contentType = multipart/form-data; // (default to multipart/form-data)
+File *file = BINARY_DATA_HERE; // multipartFile (default to null)
-// 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);
- }
+// Create a new schema.
+[apiInstance createSchemaWith:accept
+ contentType:contentType
+ file:file
+ completionHandler: ^(NSError* error) {
if (error) {
NSLog(@"Error: %@", error);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-javascript">
- <pre class="prettyprint"><code class="language-js">var TopologyAndInventoryApi = require('topology_and_inventory_api');
+ <div class="tab-pane" id="examples-Schemas-createSchema-0-javascript">
+ <pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
-var api = new TopologyAndInventoryApi.EntitiesAndRelationshipsApi()
+var api = new TopologyExposureAndInventoryApi.SchemasApi()
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 contentType = multipart/form-data; // {String}
+var file = BINARY_DATA_HERE; // {File} multipartFile
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
- console.log('API called successfully. Returned data: ' + data);
+ console.log('API called successfully.');
}
};
-api.getRelationshipsByType(accept, domainName, relationshipTypeName, opts, callback);
+api.createSchema(accept, contentType, file, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-angular">
+ <!--<div class="tab-pane" id="examples-Schemas-createSchema-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-csharp">
+ <div class="tab-pane" id="examples-Schemas-createSchema-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class getRelationshipsByTypeExample
+ public class createSchemaExample
{
public void main()
{
// Create an instance of the API class
- var apiInstance = new EntitiesAndRelationshipsApi();
+ var apiInstance = new SchemasApi();
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)
+ var contentType = multipart/form-data; // String | (default to multipart/form-data)
+ var file = BINARY_DATA_HERE; // File | multipartFile (default to null)
try {
- // Get topology relationships of a specific relationship type name.
- RelationshipsResponseMessage result = apiInstance.getRelationshipsByType(accept, domainName, relationshipTypeName, targetFilter, scopeFilter, offset, limit);
- Debug.WriteLine(result);
+ // Create a new schema.
+ apiInstance.createSchema(accept, contentType, file);
} catch (Exception e) {
- Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getRelationshipsByType: " + e.Message );
+ Debug.Print("Exception when calling SchemasApi.createSchema: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-php">
+ <div class="tab-pane" id="examples-Schemas-createSchema-0-php">
<pre class="prettyprint"><code class="language-php"><?php
require_once(__DIR__ . '/vendor/autoload.php');
// Create an instance of the API class
-$api_instance = new OpenAPITools\Client\Api\EntitiesAndRelationshipsApi();
+$api_instance = new OpenAPITools\Client\Api\SchemasApi();
$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.
+$contentType = multipart/form-data; // String |
+$file = BINARY_DATA_HERE; // File | multipartFile
try {
- $result = $api_instance->getRelationshipsByType($accept, $domainName, $relationshipTypeName, $targetFilter, $scopeFilter, $offset, $limit);
- print_r($result);
+ $api_instance->createSchema($accept, $contentType, $file);
} catch (Exception $e) {
- echo 'Exception when calling EntitiesAndRelationshipsApi->getRelationshipsByType: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling SchemasApi->createSchema: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-perl">
+ <div class="tab-pane" id="examples-Schemas-createSchema-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::EntitiesAndRelationshipsApi;
+use WWW::OPenAPIClient::SchemasApi;
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::EntitiesAndRelationshipsApi->new();
+my $api_instance = WWW::OPenAPIClient::SchemasApi->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.
+my $contentType = multipart/form-data; # String |
+my $file = BINARY_DATA_HERE; # File | multipartFile
eval {
- my $result = $api_instance->getRelationshipsByType(accept => $accept, domainName => $domainName, relationshipTypeName => $relationshipTypeName, targetFilter => $targetFilter, scopeFilter => $scopeFilter, offset => $offset, limit => $limit);
- print Dumper($result);
+ $api_instance->createSchema(accept => $accept, contentType => $contentType, file => $file);
};
if ($@) {
- warn "Exception when calling EntitiesAndRelationshipsApi->getRelationshipsByType: $@\n";
+ warn "Exception when calling SchemasApi->createSchema: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-python">
+ <div class="tab-pane" id="examples-Schemas-createSchema-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import openapi_client
from pprint import pprint
# Create an instance of the API class
-api_instance = openapi_client.EntitiesAndRelationshipsApi()
+api_instance = openapi_client.SchemasApi()
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)
+contentType = multipart/form-data # String | (default to multipart/form-data)
+file = BINARY_DATA_HERE # File | multipartFile (default to null)
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)
+ # Create a new schema.
+ api_instance.create_schema(accept, contentType, file)
except ApiException as e:
- print("Exception when calling EntitiesAndRelationshipsApi->getRelationshipsByType: %s\n" % e)</code></pre>
+ print("Exception when calling SchemasApi->createSchema: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getRelationshipsByType-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate EntitiesAndRelationshipsApi;
+ <div class="tab-pane" id="examples-Schemas-createSchema-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate SchemasApi;
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 contentType = multipart/form-data; // String
+ let file = BINARY_DATA_HERE; // File
- let mut context = EntitiesAndRelationshipsApi::Context::default();
- let result = client.getRelationshipsByType(accept, domainName, relationshipTypeName, targetFilter, scopeFilter, offset, limit, &context).wait();
+ let mut context = SchemasApi::Context::default();
+ let result = client.createSchema(accept, contentType, file, &context).wait();
println!("{:?}", result);
}
<h2>Parameters</h2>
- <div class="methodsubtabletitle">Path parameters</div>
+
+ <div class="methodsubtabletitle">Header parameters</div>
<table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">domainName*</td>
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">Accept*</td>
<td>
- <div id="d2e199_getRelationshipsByType_domainName">
+ <div id="d2e199_createSchema_accept">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
String
</span>
- <div class="inner description marked">
-domain name
- </div>
</div>
<div class="inner required">
Required
</td>
</tr>
- <tr><td style="width:150px;">relationshipTypeName*</td>
+ <tr><td style="width:150px;">Content-Type*</td>
<td>
- <div id="d2e199_getRelationshipsByType_relationshipTypeName">
+ <div id="d2e199_createSchema_contentType">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
</table>
- <div class="methodsubtabletitle">Header parameters</div>
+
+ <div class="methodsubtabletitle">Form parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
- <tr><td style="width:150px;">Accept*</td>
+ <tr><td style="width:150px;">file*</td>
<td>
- <div id="d2e199_getRelationshipsByType_accept">
+ <div id="d2e199_createSchema_file">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
- String
+ File
</span>
+ <span class="format">
+ (binary)
+ </span>
+ <div class="inner description marked">
+multipartFile
+ </div>
</div>
<div class="inner required">
Required
</table>
-
- <div class="methodsubtabletitle">Query parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">targetFilter</td>
-<td>
-
-
- <div id="d2e199_getRelationshipsByType_targetFilter">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
-
- <div class="inner description marked">
-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.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- <tr><td style="width:150px;">scopeFilter</td>
-<td>
-
-
- <div id="d2e199_getRelationshipsByType_scopeFilter">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
-
- <div class="inner description marked">
-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.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- <tr><td style="width:150px;">offset</td>
-<td>
-
-
- <div id="d2e199_getRelationshipsByType_offset">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- Integer
- </span>
-
- <div class="inner description marked">
-Pagination offset.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- <tr><td style="width:150px;">limit</td>
-<td>
-
-
- <div id="d2e199_getRelationshipsByType_limit">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- Integer
- </span>
-
- <div class="inner description marked">
-Result limiter.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- </table>
-
<h2>Responses</h2>
- <h3 id="examples-EntitiesAndRelationships-getRelationshipsByType-title-200"></h3>
- <p id="examples-EntitiesAndRelationships-getRelationshipsByType-description-200" class="marked"></p>
+ <h3 id="examples-Schemas-createSchema-title-201"></h3>
+ <p id="examples-Schemas-createSchema-description-201" class="marked"></p>
<script>
- var responseEntitiesAndRelationships200_description = `OK`;
- var responseEntitiesAndRelationships200_description_break = responseEntitiesAndRelationships200_description.indexOf('\n');
- if (responseEntitiesAndRelationships200_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
+ var responseSchemas201_description = `Created without response body`;
+ var responseSchemas201_description_break = responseSchemas201_description.indexOf('\n');
+ if (responseSchemas201_description_break == -1) {
+ $("#examples-Schemas-createSchema-title-201").text("Status: 201 - " + responseSchemas201_description);
} else {
- $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
- $("#examples-EntitiesAndRelationships-getRelationshipsByType-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
+ $("#examples-Schemas-createSchema-title-201").text("Status: 201 - " + responseSchemas201_description.substring(0, responseSchemas201_description_break));
+ $("#examples-Schemas-createSchema-description-201").html(responseSchemas201_description.substring(responseSchemas201_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getRelationshipsByType-200" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipsByType-200-schema">Schema</a>
- </li>
-
-
+ <ul id="responses-detail-Schemas-createSchema-201" class="nav nav-tabs nav-tabs-examples" >
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipsByType-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipsByType-200-schema">
- <div id="responses-EntitiesAndRelationships-getRelationshipsByType-schema-200" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-createSchema-201-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-createSchema-201-schema">
+ <div id="responses-Schemas-createSchema-schema-201" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "OK",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/RelationshipsResponseMessage"
- },
- "examples" : {
- "relationships" : {
- "$ref" : "#/components/examples/RelationshipsResponseExample"
- }
- }
- }
- }
+ "description" : "Created without response body"
};
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getRelationshipsByType-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getRelationshipsByType-schema-200');
+ $('#responses-Schemas-createSchema-201-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-createSchema-schema-201');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getRelationshipsByType-200-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-createSchema-201-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getRelationshipsByType-title-400"></h3>
- <p id="examples-EntitiesAndRelationships-getRelationshipsByType-description-400" class="marked"></p>
+ <h3 id="examples-Schemas-createSchema-title-400"></h3>
+ <p id="examples-Schemas-createSchema-description-400" class="marked"></p>
<script>
- var responseEntitiesAndRelationships400_description = `Bad Request`;
- var responseEntitiesAndRelationships400_description_break = responseEntitiesAndRelationships400_description.indexOf('\n');
- if (responseEntitiesAndRelationships400_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
+ var responseSchemas400_description = `Bad Request`;
+ var responseSchemas400_description_break = responseSchemas400_description.indexOf('\n');
+ if (responseSchemas400_description_break == -1) {
+ $("#examples-Schemas-createSchema-title-400").text("Status: 400 - " + responseSchemas400_description);
} else {
- $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
- $("#examples-EntitiesAndRelationships-getRelationshipsByType-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
+ $("#examples-Schemas-createSchema-title-400").text("Status: 400 - " + responseSchemas400_description.substring(0, responseSchemas400_description_break));
+ $("#examples-Schemas-createSchema-description-400").html(responseSchemas400_description.substring(responseSchemas400_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getRelationshipsByType-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-createSchema-400" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipsByType-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-createSchema-400-schema">Schema</a>
</li>
</ul>
-
- <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipsByType-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipsByType-400-schema">
- <div id="responses-EntitiesAndRelationships-getRelationshipsByType-schema-400" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "Bad Request",
- "content" : {
- "application/problem+json" : {
- "schema" : {
- "$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "400",
- "title" : "Bad Request",
- "details" : "The provided request is not valid"
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema == null) {
- return;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- if (schema.properties != null) {
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- }
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getRelationshipsByType-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getRelationshipsByType-schema-400');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-EntitiesAndRelationships-getRelationshipsByType-400-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- <h3 id="examples-EntitiesAndRelationships-getRelationshipsByType-title-401"></h3>
- <p id="examples-EntitiesAndRelationships-getRelationshipsByType-description-401" class="marked"></p>
- <script>
- var responseEntitiesAndRelationships401_description = `Unauthorized`;
- var responseEntitiesAndRelationships401_description_break = responseEntitiesAndRelationships401_description.indexOf('\n');
- if (responseEntitiesAndRelationships401_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
- } else {
- $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
- $("#examples-EntitiesAndRelationships-getRelationshipsByType-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-EntitiesAndRelationships-getRelationshipsByType-401" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipsByType-401-schema">Schema</a>
- </li>
-
-
-
-
- </ul>
-
-
- <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipsByType-401-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipsByType-401-schema">
- <div id="responses-EntitiesAndRelationships-getRelationshipsByType-schema-401" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "Unauthorized",
- "content" : {
- "application/problem+json" : {
- "schema" : {
- "$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "401",
- "title" : "Unauthorized request",
- "details" : "This request is unauthorized"
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema == null) {
- return;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- if (schema.properties != null) {
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- }
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getRelationshipsByType-401-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getRelationshipsByType-schema-401');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-EntitiesAndRelationships-getRelationshipsByType-401-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- <h3 id="examples-EntitiesAndRelationships-getRelationshipsByType-title-403"></h3>
- <p id="examples-EntitiesAndRelationships-getRelationshipsByType-description-403" class="marked"></p>
- <script>
- var responseEntitiesAndRelationships403_description = `Forbidden`;
- var responseEntitiesAndRelationships403_description_break = responseEntitiesAndRelationships403_description.indexOf('\n');
- if (responseEntitiesAndRelationships403_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
- } else {
- $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
- $("#examples-EntitiesAndRelationships-getRelationshipsByType-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-EntitiesAndRelationships-getRelationshipsByType-403" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipsByType-403-schema">Schema</a>
- </li>
-
-
-
-
- </ul>
-
-
- <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipsByType-403-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipsByType-403-schema">
- <div id="responses-EntitiesAndRelationships-getRelationshipsByType-schema-403" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "Forbidden",
- "content" : {
- "application/problem+json" : {
- "schema" : {
- "$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "403",
- "title" : "Request Forbidden",
- "details" : "This request is forbidden"
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema == null) {
- return;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- if (schema.properties != null) {
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- }
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getRelationshipsByType-403-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getRelationshipsByType-schema-403');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-EntitiesAndRelationships-getRelationshipsByType-403-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- <h3 id="examples-EntitiesAndRelationships-getRelationshipsByType-title-500"></h3>
- <p id="examples-EntitiesAndRelationships-getRelationshipsByType-description-500" class="marked"></p>
- <script>
- var responseEntitiesAndRelationships500_description = `Internal Server Error`;
- var responseEntitiesAndRelationships500_description_break = responseEntitiesAndRelationships500_description.indexOf('\n');
- if (responseEntitiesAndRelationships500_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description);
- } else {
- $("#examples-EntitiesAndRelationships-getRelationshipsByType-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description.substring(0, responseEntitiesAndRelationships500_description_break));
- $("#examples-EntitiesAndRelationships-getRelationshipsByType-description-500").html(responseEntitiesAndRelationships500_description.substring(responseEntitiesAndRelationships500_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-EntitiesAndRelationships-getRelationshipsByType-500" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getRelationshipsByType-500-schema">Schema</a>
- </li>
-
-
-
-
- </ul>
-
-
- <div class="tab-content" id="responses-EntitiesAndRelationships-getRelationshipsByType-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getRelationshipsByType-500-schema">
- <div id="responses-EntitiesAndRelationships-getRelationshipsByType-schema-500" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "Internal Server Error",
- "content" : {
- "application/problem+json" : {
- "schema" : {
- "$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "500",
- "title" : "Internal Server Error",
- "details" : "Internal Server Error occurred"
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema == null) {
- return;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- if (schema.properties != null) {
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- }
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getRelationshipsByType-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getRelationshipsByType-schema-500');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-EntitiesAndRelationships-getRelationshipsByType-500-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- </article>
- </div>
- <hr>
- <div id="api-EntitiesAndRelationships-getTopologyByEntityTypeName">
- <article id="api-EntitiesAndRelationships-getTopologyByEntityTypeName-0" data-group="User" data-name="getTopologyByEntityTypeName" data-version="0">
- <div class="pull-left">
- <h1>getTopologyByEntityTypeName</h1>
- <p>Get all topology entities of a specific entity type.</p>
- </div>
- <div class="pull-right"></div>
- <div class="clearfix"></div>
- <p></p>
- <p class="marked">Get all topology entities of a specific entity type.</p>
- <p></p>
- <br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains/{domainName}/entity-types/{entityTypeName}/entities</span></code></pre>
- <p>
- <h3>Usage and SDK Samples</h3>
- </p>
- <ul class="nav nav-tabs nav-tabs-examples">
- <li class="active"><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-curl">Curl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-java">Java</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-dart">Dart</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-csharp">C#</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-php">PHP</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-perl">Perl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-python">Python</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-rust">Rust</a></li>
- </ul>
-
- <div class="tab-content">
- <div class="tab-pane active" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-curl">
- <pre class="prettyprint"><code class="language-bsh">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"
-</code></pre>
- </div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-java">
- <pre class="prettyprint"><code class="language-java">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();
- }
- }
-}
-</code></pre>
- </div>
-
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-dart">
- <pre class="prettyprint"><code class="language-dart">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');
-}
-
-</code></pre>
- </div>
-
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-android">
- <pre class="prettyprint"><code class="language-java">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();
- }
- }
-}</code></pre>
- </div>
- <!--
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-groovy">
- <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
- </div> -->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-objc">
- <pre class="prettyprint"><code class="language-cpp">
-
-// 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);
- }
-}];
-</code></pre>
- </div>
-
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-javascript">
- <pre class="prettyprint"><code class="language-js">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);
-</code></pre>
- </div>
-
- <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-angular">
- <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
- </div>-->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-csharp">
- <pre class="prettyprint"><code class="language-cs">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 );
- }
- }
- }
-}
-</code></pre>
- </div>
-
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-php">
- <pre class="prettyprint"><code class="language-php"><?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;
-}
-?></code></pre>
- </div>
-
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-perl">
- <pre class="prettyprint"><code class="language-perl">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";
-}</code></pre>
- </div>
-
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-python">
- <pre class="prettyprint"><code class="language-python">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)</code></pre>
- </div>
-
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-0-rust">
- <pre class="prettyprint"><code class="language-rust">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);
-}
-</code></pre>
- </div>
- </div>
-
- <h2>Scopes</h2>
- <table>
-
- </table>
-
- <h2>Parameters</h2>
-
- <div class="methodsubtabletitle">Path parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">domainName*</td>
-<td>
-
-
- <div id="d2e199_getTopologyByEntityTypeName_domainName">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
-
- <div class="inner description marked">
-domain name
- </div>
- </div>
- <div class="inner required">
- Required
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- <tr><td style="width:150px;">entityTypeName*</td>
-<td>
-
-
- <div id="d2e199_getTopologyByEntityTypeName_entityTypeName">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
-
- </div>
- <div class="inner required">
- Required
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- </table>
-
- <div class="methodsubtabletitle">Header parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">Accept*</td>
-<td>
-
-
- <div id="d2e199_getTopologyByEntityTypeName_accept">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
-
- </div>
- <div class="inner required">
- Required
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- </table>
-
-
-
- <div class="methodsubtabletitle">Query parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">targetFilter</td>
-<td>
-
-
- <div id="d2e199_getTopologyByEntityTypeName_targetFilter">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
-
- <div class="inner description marked">
-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.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- <tr><td style="width:150px;">scopeFilter</td>
-<td>
-
-
- <div id="d2e199_getTopologyByEntityTypeName_scopeFilter">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
-
- <div class="inner description marked">
-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.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- <tr><td style="width:150px;">offset</td>
-<td>
-
-
- <div id="d2e199_getTopologyByEntityTypeName_offset">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- Integer
- </span>
-
- <div class="inner description marked">
-Pagination offset.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- <tr><td style="width:150px;">limit</td>
-<td>
-
-
- <div id="d2e199_getTopologyByEntityTypeName_limit">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- Integer
- </span>
-
- <div class="inner description marked">
-Result limiter.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- </table>
-
- <h2>Responses</h2>
- <h3 id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-200"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-200" class="marked"></p>
- <script>
- var responseEntitiesAndRelationships200_description = `OK`;
- var responseEntitiesAndRelationships200_description_break = responseEntitiesAndRelationships200_description.indexOf('\n');
- if (responseEntitiesAndRelationships200_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
- } else {
- $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyByEntityTypeName-200" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-200-schema">Schema</a>
- </li>
-
-
-
-
- </ul>
-
-
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-200-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-200" class="exampleStyle">
+
+ <div class="tab-content" id="responses-Schemas-createSchema-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-createSchema-400-schema">
+ <div id="responses-Schemas-createSchema-schema-400" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "OK",
+ "description" : "Bad Request",
"content" : {
- "application/json" : {
+ "application/problem+json" : {
"schema" : {
- "$ref" : "#/components/schemas/EntitiesResponseMessage"
+ "$ref" : "#/components/schemas/ErrorMessage"
},
- "examples" : {
- "entities" : {
- "$ref" : "#/components/examples/EntitiesResponseExample"
- }
+ "example" : {
+ "status" : "400",
+ "title" : "Bad Request",
+ "details" : "The provided request is not valid"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-200');
+ $('#responses-Schemas-createSchema-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-createSchema-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyByEntityTypeName-200-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-createSchema-400-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-400"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-400" class="marked"></p>
+ <h3 id="examples-Schemas-createSchema-title-401"></h3>
+ <p id="examples-Schemas-createSchema-description-401" class="marked"></p>
<script>
- var responseEntitiesAndRelationships400_description = `Bad Request`;
- var responseEntitiesAndRelationships400_description_break = responseEntitiesAndRelationships400_description.indexOf('\n');
- if (responseEntitiesAndRelationships400_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
+ var responseSchemas401_description = `Unauthorized`;
+ var responseSchemas401_description_break = responseSchemas401_description.indexOf('\n');
+ if (responseSchemas401_description_break == -1) {
+ $("#examples-Schemas-createSchema-title-401").text("Status: 401 - " + responseSchemas401_description);
} else {
- $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
+ $("#examples-Schemas-createSchema-title-401").text("Status: 401 - " + responseSchemas401_description.substring(0, responseSchemas401_description_break));
+ $("#examples-Schemas-createSchema-description-401").html(responseSchemas401_description.substring(responseSchemas401_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyByEntityTypeName-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-createSchema-401" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-createSchema-401-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-400-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-createSchema-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-createSchema-401-schema">
+ <div id="responses-Schemas-createSchema-schema-401" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Bad Request",
+ "description" : "Unauthorized",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
- "status" : "400",
- "title" : "Bad Request",
- "details" : "The provided request is not valid"
+ "status" : "401",
+ "title" : "Unauthorized request",
+ "details" : "This request is unauthorized"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-400');
+ $('#responses-Schemas-createSchema-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-createSchema-schema-401');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyByEntityTypeName-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-createSchema-401-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-401"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-401" class="marked"></p>
+ <h3 id="examples-Schemas-createSchema-title-403"></h3>
+ <p id="examples-Schemas-createSchema-description-403" class="marked"></p>
<script>
- var responseEntitiesAndRelationships401_description = `Unauthorized`;
- var responseEntitiesAndRelationships401_description_break = responseEntitiesAndRelationships401_description.indexOf('\n');
- if (responseEntitiesAndRelationships401_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
+ var responseSchemas403_description = `Forbidden`;
+ var responseSchemas403_description_break = responseSchemas403_description.indexOf('\n');
+ if (responseSchemas403_description_break == -1) {
+ $("#examples-Schemas-createSchema-title-403").text("Status: 403 - " + responseSchemas403_description);
} else {
- $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
+ $("#examples-Schemas-createSchema-title-403").text("Status: 403 - " + responseSchemas403_description.substring(0, responseSchemas403_description_break));
+ $("#examples-Schemas-createSchema-description-403").html(responseSchemas403_description.substring(responseSchemas403_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyByEntityTypeName-401" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-createSchema-403" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-401-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-createSchema-403-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-401-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-401-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-401" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-createSchema-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-createSchema-403-schema">
+ <div id="responses-Schemas-createSchema-schema-403" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Unauthorized",
+ "description" : "Forbidden",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
- "status" : "401",
- "title" : "Unauthorized request",
- "details" : "This request is unauthorized"
+ "status" : "403",
+ "title" : "Request Forbidden",
+ "details" : "This request is forbidden"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-401-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-401');
+ $('#responses-Schemas-createSchema-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-createSchema-schema-403');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyByEntityTypeName-401-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-createSchema-403-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-403"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-403" class="marked"></p>
+ <h3 id="examples-Schemas-createSchema-title-409"></h3>
+ <p id="examples-Schemas-createSchema-description-409" class="marked"></p>
<script>
- var responseEntitiesAndRelationships403_description = `Forbidden`;
- var responseEntitiesAndRelationships403_description_break = responseEntitiesAndRelationships403_description.indexOf('\n');
- if (responseEntitiesAndRelationships403_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
+ var responseSchemas409_description = `Conflict`;
+ var responseSchemas409_description_break = responseSchemas409_description.indexOf('\n');
+ if (responseSchemas409_description_break == -1) {
+ $("#examples-Schemas-createSchema-title-409").text("Status: 409 - " + responseSchemas409_description);
} else {
- $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
+ $("#examples-Schemas-createSchema-title-409").text("Status: 409 - " + responseSchemas409_description.substring(0, responseSchemas409_description_break));
+ $("#examples-Schemas-createSchema-description-409").html(responseSchemas409_description.substring(responseSchemas409_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyByEntityTypeName-403" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-createSchema-409" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-403-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-createSchema-409-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-403-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-403-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-403" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-createSchema-409-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-createSchema-409-schema">
+ <div id="responses-Schemas-createSchema-schema-409" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Forbidden",
+ "description" : "Conflict",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
- "status" : "403",
- "title" : "Request Forbidden",
- "details" : "This request is forbidden"
+ "status" : "409",
+ "title" : "Conflicting request",
+ "details" : "The request cannot be processed as the resource is in use."
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-403-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-403');
+ $('#responses-Schemas-createSchema-409-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-createSchema-schema-409');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyByEntityTypeName-403-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-createSchema-409-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-500"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-500" class="marked"></p>
+ <h3 id="examples-Schemas-createSchema-title-500"></h3>
+ <p id="examples-Schemas-createSchema-description-500" class="marked"></p>
<script>
- var responseEntitiesAndRelationships500_description = `Internal Server Error`;
- var responseEntitiesAndRelationships500_description_break = responseEntitiesAndRelationships500_description.indexOf('\n');
- if (responseEntitiesAndRelationships500_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description);
+ var responseSchemas500_description = `Internal Server Error`;
+ var responseSchemas500_description_break = responseSchemas500_description.indexOf('\n');
+ if (responseSchemas500_description_break == -1) {
+ $("#examples-Schemas-createSchema-title-500").text("Status: 500 - " + responseSchemas500_description);
} else {
- $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description.substring(0, responseEntitiesAndRelationships500_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyByEntityTypeName-description-500").html(responseEntitiesAndRelationships500_description.substring(responseEntitiesAndRelationships500_description_break));
+ $("#examples-Schemas-createSchema-title-500").text("Status: 500 - " + responseSchemas500_description.substring(0, responseSchemas500_description_break));
+ $("#examples-Schemas-createSchema-description-500").html(responseSchemas500_description.substring(responseSchemas500_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyByEntityTypeName-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-createSchema-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-createSchema-500-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-500-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-createSchema-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-createSchema-500-schema">
+ <div id="responses-Schemas-createSchema-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyByEntityTypeName-schema-500');
+ $('#responses-Schemas-createSchema-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-createSchema-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyByEntityTypeName-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-createSchema-500-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- <div id="api-EntitiesAndRelationships-getTopologyById">
- <article id="api-EntitiesAndRelationships-getTopologyById-0" data-group="User" data-name="getTopologyById" data-version="0">
+ <div id="api-Schemas-deleteSchema">
+ <article id="api-Schemas-deleteSchema-0" data-group="User" data-name="deleteSchema" data-version="0">
<div class="pull-left">
- <h1>getTopologyById</h1>
- <p>Get topology for entity type name with specified id. Specified id represents the entity instance.</p>
+ <h1>deleteSchema</h1>
+ <p>Delete a schema.</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Get topology for entity type name with specified id. Specified id represents the entity instance.</p>
+ <p class="marked">Delete a schema.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains/{domainName}/entity-types/{entityTypeName}/entities/{entityId}</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="delete"><code><span class="pln">/schemas/{schemaName}</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
- <li class="active"><a href="#examples-EntitiesAndRelationships-getTopologyById-0-curl">Curl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-java">Java</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-dart">Dart</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-csharp">C#</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-php">PHP</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-perl">Perl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-python">Python</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyById-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-Schemas-deleteSchema-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-Schemas-deleteSchema-0-java">Java</a></li>
+ <li class=""><a href="#examples-Schemas-deleteSchema-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-Schemas-deleteSchema-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-Schemas-deleteSchema-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-Schemas-deleteSchema-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-Schemas-deleteSchema-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-Schemas-deleteSchema-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-Schemas-deleteSchema-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-Schemas-deleteSchema-0-php">PHP</a></li>
+ <li class=""><a href="#examples-Schemas-deleteSchema-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-Schemas-deleteSchema-0-python">Python</a></li>
+ <li class=""><a href="#examples-Schemas-deleteSchema-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-EntitiesAndRelationships-getTopologyById-0-curl">
- <pre class="prettyprint"><code class="language-bsh">curl -X GET \
- -H "Accept: application/yang.data+json,application/problem+json" \
- "https://localhost/topology-inventory/v1alpha11/domains/{domainName}/entity-types/{entityTypeName}/entities/{entityId}"
+ <div class="tab-pane active" id="examples-Schemas-deleteSchema-0-curl">
+ <pre class="prettyprint"><code class="language-bsh">curl -X DELETE \
+ -H "Accept: application/problem+json" \
+ "https://localhost/topology-inventory/v1alpha11/schemas/{schemaName}"
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-java">
+ <div class="tab-pane" id="examples-Schemas-deleteSchema-0-java">
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
-import org.openapitools.client.api.EntitiesAndRelationshipsApi;
+import org.openapitools.client.api.SchemasApi;
import java.io.File;
import java.util.*;
-public class EntitiesAndRelationshipsApiExample {
+public class SchemasApiExample {
public static void main(String[] args) {
// Create an instance of the API class
- EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
+ SchemasApi apiInstance = new SchemasApi();
String accept = application/json; // String |
- String domainName = domainName_example; // String | domain name
- String entityTypeName = entityTypeName_example; // String |
- String entityId = entityId_example; // String |
+ String schemaName = schemaName_example; // String |
try {
- Object result = apiInstance.getTopologyById(accept, domainName, entityTypeName, entityId);
- System.out.println(result);
+ apiInstance.deleteSchema(accept, schemaName);
} catch (ApiException e) {
- System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyById");
+ System.err.println("Exception when calling SchemasApi#deleteSchema");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-dart">
+ <div class="tab-pane" id="examples-Schemas-deleteSchema-0-dart">
<pre class="prettyprint"><code class="language-dart">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 schemaName = new String(); // String |
try {
- final result = await api_instance.getTopologyById(accept, domainName, entityTypeName, entityId);
+ final result = await api_instance.deleteSchema(accept, schemaName);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->getTopologyById: $e\n');
+ print('Exception when calling DefaultApi->deleteSchema: $e\n');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.EntitiesAndRelationshipsApi;
+ <div class="tab-pane" id="examples-Schemas-deleteSchema-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.SchemasApi;
-public class EntitiesAndRelationshipsApiExample {
+public class SchemasApiExample {
public static void main(String[] args) {
- EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
+ SchemasApi apiInstance = new SchemasApi();
String accept = application/json; // String |
- String domainName = domainName_example; // String | domain name
- String entityTypeName = entityTypeName_example; // String |
- String entityId = entityId_example; // String |
+ String schemaName = schemaName_example; // String |
try {
- Object result = apiInstance.getTopologyById(accept, domainName, entityTypeName, entityId);
- System.out.println(result);
+ apiInstance.deleteSchema(accept, schemaName);
} catch (ApiException e) {
- System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyById");
+ System.err.println("Exception when calling SchemasApi#deleteSchema");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-groovy">
+ <div class="tab-pane" id="examples-Schemas-deleteSchema-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-objc">
+ <div class="tab-pane" id="examples-Schemas-deleteSchema-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// Create an instance of the API class
-EntitiesAndRelationshipsApi *apiInstance = [[EntitiesAndRelationshipsApi alloc] init];
+SchemasApi *apiInstance = [[SchemasApi 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 *schemaName = schemaName_example; // (default to o-ran-smo-teiv-ran)
-// 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);
- }
+// Delete a schema.
+[apiInstance deleteSchemaWith:accept
+ schemaName:schemaName
+ completionHandler: ^(NSError* error) {
if (error) {
NSLog(@"Error: %@", error);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-javascript">
- <pre class="prettyprint"><code class="language-js">var TopologyAndInventoryApi = require('topology_and_inventory_api');
+ <div class="tab-pane" id="examples-Schemas-deleteSchema-0-javascript">
+ <pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
-var api = new TopologyAndInventoryApi.EntitiesAndRelationshipsApi()
+var api = new TopologyExposureAndInventoryApi.SchemasApi()
var accept = application/json; // {String}
-var domainName = domainName_example; // {String} domain name
-var entityTypeName = entityTypeName_example; // {String}
-var entityId = entityId_example; // {String}
+var schemaName = schemaName_example; // {String}
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
- console.log('API called successfully. Returned data: ' + data);
+ console.log('API called successfully.');
}
};
-api.getTopologyById(accept, domainName, entityTypeName, entityId, callback);
+api.deleteSchema(accept, schemaName, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-angular">
+ <!--<div class="tab-pane" id="examples-Schemas-deleteSchema-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-csharp">
+ <div class="tab-pane" id="examples-Schemas-deleteSchema-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class getTopologyByIdExample
+ public class deleteSchemaExample
{
public void main()
{
// Create an instance of the API class
- var apiInstance = new EntitiesAndRelationshipsApi();
+ var apiInstance = new SchemasApi();
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 schemaName = schemaName_example; // String | (default to o-ran-smo-teiv-ran)
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);
+ // Delete a schema.
+ apiInstance.deleteSchema(accept, schemaName);
} catch (Exception e) {
- Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getTopologyById: " + e.Message );
+ Debug.Print("Exception when calling SchemasApi.deleteSchema: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-php">
+ <div class="tab-pane" id="examples-Schemas-deleteSchema-0-php">
<pre class="prettyprint"><code class="language-php"><?php
require_once(__DIR__ . '/vendor/autoload.php');
// Create an instance of the API class
-$api_instance = new OpenAPITools\Client\Api\EntitiesAndRelationshipsApi();
+$api_instance = new OpenAPITools\Client\Api\SchemasApi();
$accept = application/json; // String |
-$domainName = domainName_example; // String | domain name
-$entityTypeName = entityTypeName_example; // String |
-$entityId = entityId_example; // String |
+$schemaName = schemaName_example; // String |
try {
- $result = $api_instance->getTopologyById($accept, $domainName, $entityTypeName, $entityId);
- print_r($result);
+ $api_instance->deleteSchema($accept, $schemaName);
} catch (Exception $e) {
- echo 'Exception when calling EntitiesAndRelationshipsApi->getTopologyById: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling SchemasApi->deleteSchema: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-perl">
+ <div class="tab-pane" id="examples-Schemas-deleteSchema-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::EntitiesAndRelationshipsApi;
+use WWW::OPenAPIClient::SchemasApi;
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::EntitiesAndRelationshipsApi->new();
+my $api_instance = WWW::OPenAPIClient::SchemasApi->new();
my $accept = application/json; # String |
-my $domainName = domainName_example; # String | domain name
-my $entityTypeName = entityTypeName_example; # String |
-my $entityId = entityId_example; # String |
+my $schemaName = schemaName_example; # String |
eval {
- my $result = $api_instance->getTopologyById(accept => $accept, domainName => $domainName, entityTypeName => $entityTypeName, entityId => $entityId);
- print Dumper($result);
+ $api_instance->deleteSchema(accept => $accept, schemaName => $schemaName);
};
if ($@) {
- warn "Exception when calling EntitiesAndRelationshipsApi->getTopologyById: $@\n";
+ warn "Exception when calling SchemasApi->deleteSchema: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-python">
+ <div class="tab-pane" id="examples-Schemas-deleteSchema-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import openapi_client
from pprint import pprint
# Create an instance of the API class
-api_instance = openapi_client.EntitiesAndRelationshipsApi()
+api_instance = openapi_client.SchemasApi()
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)
+schemaName = schemaName_example # String | (default to o-ran-smo-teiv-ran)
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)
+ # Delete a schema.
+ api_instance.delete_schema(accept, schemaName)
except ApiException as e:
- print("Exception when calling EntitiesAndRelationshipsApi->getTopologyById: %s\n" % e)</code></pre>
+ print("Exception when calling SchemasApi->deleteSchema: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyById-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate EntitiesAndRelationshipsApi;
+ <div class="tab-pane" id="examples-Schemas-deleteSchema-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate SchemasApi;
pub fn main() {
let accept = application/json; // String
- let domainName = domainName_example; // String
- let entityTypeName = entityTypeName_example; // String
- let entityId = entityId_example; // String
+ let schemaName = schemaName_example; // String
- let mut context = EntitiesAndRelationshipsApi::Context::default();
- let result = client.getTopologyById(accept, domainName, entityTypeName, entityId, &context).wait();
+ let mut context = SchemasApi::Context::default();
+ let result = client.deleteSchema(accept, schemaName, &context).wait();
println!("{:?}", result);
}
<th width="150px">Name</th>
<th>Description</th>
</tr>
- <tr><td style="width:150px;">domainName*</td>
-<td>
-
-
- <div id="d2e199_getTopologyById_domainName">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
-
- <div class="inner description marked">
-domain name
- </div>
- </div>
- <div class="inner required">
- Required
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- <tr><td style="width:150px;">entityTypeName*</td>
-<td>
-
-
- <div id="d2e199_getTopologyById_entityTypeName">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
-
- </div>
- <div class="inner required">
- Required
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- <tr><td style="width:150px;">entityId*</td>
+ <tr><td style="width:150px;">schemaName*</td>
<td>
- <div id="d2e199_getTopologyById_entityId">
+ <div id="d2e199_deleteSchema_schemaName">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
<td>
- <div id="d2e199_getTopologyById_accept">
+ <div id="d2e199_deleteSchema_accept">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
<h2>Responses</h2>
- <h3 id="examples-EntitiesAndRelationships-getTopologyById-title-200"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyById-description-200" class="marked"></p>
- <script>
- var responseEntitiesAndRelationships200_description = `OK`;
- var responseEntitiesAndRelationships200_description_break = responseEntitiesAndRelationships200_description.indexOf('\n');
- if (responseEntitiesAndRelationships200_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyById-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
- } else {
- $("#examples-EntitiesAndRelationships-getTopologyById-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyById-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
- }
- </script>
-
-
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyById-200" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyById-200-schema">Schema</a>
- </li>
-
-
-
-
- </ul>
-
-
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyById-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyById-200-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyById-schema-200" class="exampleStyle">
- <script>
- $(document).ready(function() {
- var schemaWrapper = {
- "description" : "OK",
- "content" : {
- "application/yang.data+json" : {
- "schema" : {
- "type" : "object",
- "description" : "Refer to yang model for schema definition"
- },
- "examples" : {
- "entity" : {
- "$ref" : "#/components/examples/EntityResponseExample"
- }
- }
- }
- }
-};
- var schema = findNode('schema',schemaWrapper).schema;
- if (!schema) {
- schema = schemaWrapper.schema;
- }
- if (schema == null) {
- return;
- }
- if (schema.$ref != null) {
- schema = defsParser.$refs.get(schema.$ref);
- if (schema.properties != null) {
- Object.keys(schema.properties).forEach( (item) => {
- if (schema.properties[item].$ref != null) {
- schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
- }
- });
- }
- } else if (schema.items != null && schema.items.$ref != null) {
- schema.items = defsParser.$refs.get(schema.items.$ref);
- } else {
- schemaWrapper.definitions = Object.assign({}, defs);
- $RefParser.dereference(schemaWrapper).catch(function(err) {
- console.log(err);
- });
- }
-
- var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyById-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyById-schema-200');
- result.empty();
- result.append(view.render());
- });
- </script>
- </div>
- <input id='responses-EntitiesAndRelationships-getTopologyById-200-schema-data' type='hidden' value=''></input>
- </div>
- </div>
- <h3 id="examples-EntitiesAndRelationships-getTopologyById-title-400"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyById-description-400" class="marked"></p>
- <script>
- var responseEntitiesAndRelationships400_description = `Bad Request`;
- var responseEntitiesAndRelationships400_description_break = responseEntitiesAndRelationships400_description.indexOf('\n');
- if (responseEntitiesAndRelationships400_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyById-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
+ <h3 id="examples-Schemas-deleteSchema-title-204"></h3>
+ <p id="examples-Schemas-deleteSchema-description-204" class="marked"></p>
+ <script>
+ var responseSchemas204_description = `No Content`;
+ var responseSchemas204_description_break = responseSchemas204_description.indexOf('\n');
+ if (responseSchemas204_description_break == -1) {
+ $("#examples-Schemas-deleteSchema-title-204").text("Status: 204 - " + responseSchemas204_description);
} else {
- $("#examples-EntitiesAndRelationships-getTopologyById-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyById-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
+ $("#examples-Schemas-deleteSchema-title-204").text("Status: 204 - " + responseSchemas204_description.substring(0, responseSchemas204_description_break));
+ $("#examples-Schemas-deleteSchema-description-204").html(responseSchemas204_description.substring(responseSchemas204_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyById-400" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyById-400-schema">Schema</a>
- </li>
-
-
+ <ul id="responses-detail-Schemas-deleteSchema-204" class="nav nav-tabs nav-tabs-examples" >
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyById-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyById-400-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyById-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-deleteSchema-204-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-deleteSchema-204-schema">
+ <div id="responses-Schemas-deleteSchema-schema-204" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Bad Request",
- "content" : {
- "application/problem+json" : {
- "schema" : {
- "$ref" : "#/components/schemas/ErrorMessage"
- },
- "example" : {
- "status" : "400",
- "title" : "Bad Request",
- "details" : "The provided request is not valid"
- }
- }
- }
+ "description" : "No Content",
+ "content" : { }
};
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyById-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyById-schema-400');
+ $('#responses-Schemas-deleteSchema-204-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-deleteSchema-schema-204');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyById-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-deleteSchema-204-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getTopologyById-title-401"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyById-description-401" class="marked"></p>
+ <h3 id="examples-Schemas-deleteSchema-title-400"></h3>
+ <p id="examples-Schemas-deleteSchema-description-400" class="marked"></p>
<script>
- var responseEntitiesAndRelationships401_description = `Unauthorized`;
- var responseEntitiesAndRelationships401_description_break = responseEntitiesAndRelationships401_description.indexOf('\n');
- if (responseEntitiesAndRelationships401_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyById-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
+ var responseSchemas400_description = `Bad Request`;
+ var responseSchemas400_description_break = responseSchemas400_description.indexOf('\n');
+ if (responseSchemas400_description_break == -1) {
+ $("#examples-Schemas-deleteSchema-title-400").text("Status: 400 - " + responseSchemas400_description);
} else {
- $("#examples-EntitiesAndRelationships-getTopologyById-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyById-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
+ $("#examples-Schemas-deleteSchema-title-400").text("Status: 400 - " + responseSchemas400_description.substring(0, responseSchemas400_description_break));
+ $("#examples-Schemas-deleteSchema-description-400").html(responseSchemas400_description.substring(responseSchemas400_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyById-401" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-deleteSchema-400" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyById-401-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-deleteSchema-400-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyById-401-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyById-401-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyById-schema-401" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-deleteSchema-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-deleteSchema-400-schema">
+ <div id="responses-Schemas-deleteSchema-schema-400" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Unauthorized",
+ "description" : "Bad Request",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
- "status" : "401",
- "title" : "Unauthorized request",
- "details" : "This request is unauthorized"
+ "status" : "400",
+ "title" : "Bad Request",
+ "details" : "The provided request is not valid"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyById-401-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyById-schema-401');
+ $('#responses-Schemas-deleteSchema-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-deleteSchema-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyById-401-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-deleteSchema-400-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getTopologyById-title-403"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyById-description-403" class="marked"></p>
+ <h3 id="examples-Schemas-deleteSchema-title-401"></h3>
+ <p id="examples-Schemas-deleteSchema-description-401" class="marked"></p>
<script>
- var responseEntitiesAndRelationships403_description = `Forbidden`;
- var responseEntitiesAndRelationships403_description_break = responseEntitiesAndRelationships403_description.indexOf('\n');
- if (responseEntitiesAndRelationships403_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyById-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
+ var responseSchemas401_description = `Unauthorized`;
+ var responseSchemas401_description_break = responseSchemas401_description.indexOf('\n');
+ if (responseSchemas401_description_break == -1) {
+ $("#examples-Schemas-deleteSchema-title-401").text("Status: 401 - " + responseSchemas401_description);
} else {
- $("#examples-EntitiesAndRelationships-getTopologyById-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyById-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
+ $("#examples-Schemas-deleteSchema-title-401").text("Status: 401 - " + responseSchemas401_description.substring(0, responseSchemas401_description_break));
+ $("#examples-Schemas-deleteSchema-description-401").html(responseSchemas401_description.substring(responseSchemas401_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyById-403" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-deleteSchema-401" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyById-403-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-deleteSchema-401-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyById-403-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyById-403-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyById-schema-403" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-deleteSchema-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-deleteSchema-401-schema">
+ <div id="responses-Schemas-deleteSchema-schema-401" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Forbidden",
+ "description" : "Unauthorized",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
- "status" : "403",
- "title" : "Request Forbidden",
- "details" : "This request is forbidden"
+ "status" : "401",
+ "title" : "Unauthorized request",
+ "details" : "This request is unauthorized"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyById-403-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyById-schema-403');
+ $('#responses-Schemas-deleteSchema-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-deleteSchema-schema-401');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyById-403-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-deleteSchema-401-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getTopologyById-title-404"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyById-description-404" class="marked"></p>
+ <h3 id="examples-Schemas-deleteSchema-title-403"></h3>
+ <p id="examples-Schemas-deleteSchema-description-403" class="marked"></p>
<script>
- var responseEntitiesAndRelationships404_description = `Not Found`;
- var responseEntitiesAndRelationships404_description_break = responseEntitiesAndRelationships404_description.indexOf('\n');
- if (responseEntitiesAndRelationships404_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyById-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description);
+ var responseSchemas403_description = `Forbidden`;
+ var responseSchemas403_description_break = responseSchemas403_description.indexOf('\n');
+ if (responseSchemas403_description_break == -1) {
+ $("#examples-Schemas-deleteSchema-title-403").text("Status: 403 - " + responseSchemas403_description);
} else {
- $("#examples-EntitiesAndRelationships-getTopologyById-title-404").text("Status: 404 - " + responseEntitiesAndRelationships404_description.substring(0, responseEntitiesAndRelationships404_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyById-description-404").html(responseEntitiesAndRelationships404_description.substring(responseEntitiesAndRelationships404_description_break));
+ $("#examples-Schemas-deleteSchema-title-403").text("Status: 403 - " + responseSchemas403_description.substring(0, responseSchemas403_description_break));
+ $("#examples-Schemas-deleteSchema-description-403").html(responseSchemas403_description.substring(responseSchemas403_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyById-404" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-deleteSchema-403" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyById-404-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-deleteSchema-403-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyById-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyById-404-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyById-schema-404" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-deleteSchema-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-deleteSchema-403-schema">
+ <div id="responses-Schemas-deleteSchema-schema-403" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Not Found",
+ "description" : "Forbidden",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
- "status" : "404",
- "title" : "Resource Not Found",
- "details" : "The requested resource is not found"
+ "status" : "403",
+ "title" : "Request Forbidden",
+ "details" : "This request is forbidden"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyById-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyById-schema-404');
+ $('#responses-Schemas-deleteSchema-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-deleteSchema-schema-403');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyById-404-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-deleteSchema-403-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getTopologyById-title-500"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyById-description-500" class="marked"></p>
+ <h3 id="examples-Schemas-deleteSchema-title-500"></h3>
+ <p id="examples-Schemas-deleteSchema-description-500" class="marked"></p>
<script>
- var responseEntitiesAndRelationships500_description = `Internal Server Error`;
- var responseEntitiesAndRelationships500_description_break = responseEntitiesAndRelationships500_description.indexOf('\n');
- if (responseEntitiesAndRelationships500_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyById-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description);
+ var responseSchemas500_description = `Internal Server Error`;
+ var responseSchemas500_description_break = responseSchemas500_description.indexOf('\n');
+ if (responseSchemas500_description_break == -1) {
+ $("#examples-Schemas-deleteSchema-title-500").text("Status: 500 - " + responseSchemas500_description);
} else {
- $("#examples-EntitiesAndRelationships-getTopologyById-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description.substring(0, responseEntitiesAndRelationships500_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyById-description-500").html(responseEntitiesAndRelationships500_description.substring(responseEntitiesAndRelationships500_description_break));
+ $("#examples-Schemas-deleteSchema-title-500").text("Status: 500 - " + responseSchemas500_description.substring(0, responseSchemas500_description_break));
+ $("#examples-Schemas-deleteSchema-description-500").html(responseSchemas500_description.substring(responseSchemas500_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyById-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-deleteSchema-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyById-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-deleteSchema-500-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyById-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyById-500-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyById-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-deleteSchema-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-deleteSchema-500-schema">
+ <div id="responses-Schemas-deleteSchema-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyById-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyById-schema-500');
+ $('#responses-Schemas-deleteSchema-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-deleteSchema-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyById-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-deleteSchema-500-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- <div id="api-EntitiesAndRelationships-getTopologyEntityTypes">
- <article id="api-EntitiesAndRelationships-getTopologyEntityTypes-0" data-group="User" data-name="getTopologyEntityTypes" data-version="0">
+ <div id="api-Schemas-getSchemaByName">
+ <article id="api-Schemas-getSchemaByName-0" data-group="User" data-name="getSchemaByName" data-version="0">
<div class="pull-left">
- <h1>getTopologyEntityTypes</h1>
- <p>Get all the available topology entity types in domain name.</p>
+ <h1>getSchemaByName</h1>
+ <p>Get the model schema.</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Get all the available topology entity types in domain name.</p>
+ <p class="marked">Get the model schema by name.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains/{domainName}/entity-types</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/schemas/{schemaName}/content</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
- <li class="active"><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-curl">Curl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-java">Java</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-dart">Dart</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-csharp">C#</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-php">PHP</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-perl">Perl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-python">Python</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyEntityTypes-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-Schemas-getSchemaByName-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-Schemas-getSchemaByName-0-java">Java</a></li>
+ <li class=""><a href="#examples-Schemas-getSchemaByName-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-Schemas-getSchemaByName-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-Schemas-getSchemaByName-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-Schemas-getSchemaByName-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-Schemas-getSchemaByName-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-Schemas-getSchemaByName-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-Schemas-getSchemaByName-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-Schemas-getSchemaByName-0-php">PHP</a></li>
+ <li class=""><a href="#examples-Schemas-getSchemaByName-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-Schemas-getSchemaByName-0-python">Python</a></li>
+ <li class=""><a href="#examples-Schemas-getSchemaByName-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-curl">
+ <div class="tab-pane active" id="examples-Schemas-getSchemaByName-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X GET \
- -H "Accept: application/json,application/problem+json" \
- "https://localhost/topology-inventory/v1alpha11/domains/{domainName}/entity-types?offset=56&limit=56"
+ -H "Accept: text/plain,application/problem+json" \
+ "https://localhost/topology-inventory/v1alpha11/schemas/{schemaName}/content"
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-java">
+ <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-java">
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
-import org.openapitools.client.api.EntitiesAndRelationshipsApi;
+import org.openapitools.client.api.SchemasApi;
import java.io.File;
import java.util.*;
-public class EntitiesAndRelationshipsApiExample {
+public class SchemasApiExample {
public static void main(String[] args) {
// Create an instance of the API class
- EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
+ SchemasApi apiInstance = new SchemasApi();
String accept = application/json; // String |
- String domainName = domainName_example; // String | domain name
- Integer offset = 56; // Integer | Pagination offset.
- Integer limit = 56; // Integer | Result limiter.
+ String schemaName = schemaName_example; // String |
try {
- EntityTypes result = apiInstance.getTopologyEntityTypes(accept, domainName, offset, limit);
+ 'String' result = apiInstance.getSchemaByName(accept, schemaName);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyEntityTypes");
+ System.err.println("Exception when calling SchemasApi#getSchemaByName");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-dart">
+ <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-dart">
<pre class="prettyprint"><code class="language-dart">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.
+final String schemaName = new String(); // String |
try {
- final result = await api_instance.getTopologyEntityTypes(accept, domainName, offset, limit);
+ final result = await api_instance.getSchemaByName(accept, schemaName);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->getTopologyEntityTypes: $e\n');
+ print('Exception when calling DefaultApi->getSchemaByName: $e\n');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.EntitiesAndRelationshipsApi;
+ <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.SchemasApi;
-public class EntitiesAndRelationshipsApiExample {
+public class SchemasApiExample {
public static void main(String[] args) {
- EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
+ SchemasApi apiInstance = new SchemasApi();
String accept = application/json; // String |
- String domainName = domainName_example; // String | domain name
- Integer offset = 56; // Integer | Pagination offset.
- Integer limit = 56; // Integer | Result limiter.
+ String schemaName = schemaName_example; // String |
try {
- EntityTypes result = apiInstance.getTopologyEntityTypes(accept, domainName, offset, limit);
+ 'String' result = apiInstance.getSchemaByName(accept, schemaName);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyEntityTypes");
+ System.err.println("Exception when calling SchemasApi#getSchemaByName");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-groovy">
+ <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-objc">
+ <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// Create an instance of the API class
-EntitiesAndRelationshipsApi *apiInstance = [[EntitiesAndRelationshipsApi alloc] init];
+SchemasApi *apiInstance = [[SchemasApi 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)
+String *schemaName = schemaName_example; // (default to o-ran-smo-teiv-ran)
-// Get all the available topology entity types in domain name.
-[apiInstance getTopologyEntityTypesWith:accept
- domainName:domainName
- offset:offset
- limit:limit
- completionHandler: ^(EntityTypes output, NSError* error) {
+// Get the model schema.
+[apiInstance getSchemaByNameWith:accept
+ schemaName:schemaName
+ completionHandler: ^('String' output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-javascript">
- <pre class="prettyprint"><code class="language-js">var TopologyAndInventoryApi = require('topology_and_inventory_api');
+ <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-javascript">
+ <pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
-var api = new TopologyAndInventoryApi.EntitiesAndRelationshipsApi()
+var api = new TopologyExposureAndInventoryApi.SchemasApi()
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 schemaName = schemaName_example; // {String}
var callback = function(error, data, response) {
if (error) {
console.log('API called successfully. Returned data: ' + data);
}
};
-api.getTopologyEntityTypes(accept, domainName, opts, callback);
+api.getSchemaByName(accept, schemaName, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-angular">
+ <!--<div class="tab-pane" id="examples-Schemas-getSchemaByName-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-csharp">
+ <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class getTopologyEntityTypesExample
+ public class getSchemaByNameExample
{
public void main()
{
// Create an instance of the API class
- var apiInstance = new EntitiesAndRelationshipsApi();
+ var apiInstance = new SchemasApi();
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)
+ var schemaName = schemaName_example; // String | (default to o-ran-smo-teiv-ran)
try {
- // Get all the available topology entity types in domain name.
- EntityTypes result = apiInstance.getTopologyEntityTypes(accept, domainName, offset, limit);
+ // Get the model schema.
+ 'String' result = apiInstance.getSchemaByName(accept, schemaName);
Debug.WriteLine(result);
} catch (Exception e) {
- Debug.Print("Exception when calling EntitiesAndRelationshipsApi.getTopologyEntityTypes: " + e.Message );
+ Debug.Print("Exception when calling SchemasApi.getSchemaByName: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-php">
+ <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-php">
<pre class="prettyprint"><code class="language-php"><?php
require_once(__DIR__ . '/vendor/autoload.php');
// Create an instance of the API class
-$api_instance = new OpenAPITools\Client\Api\EntitiesAndRelationshipsApi();
+$api_instance = new OpenAPITools\Client\Api\SchemasApi();
$accept = application/json; // String |
-$domainName = domainName_example; // String | domain name
-$offset = 56; // Integer | Pagination offset.
-$limit = 56; // Integer | Result limiter.
+$schemaName = schemaName_example; // String |
try {
- $result = $api_instance->getTopologyEntityTypes($accept, $domainName, $offset, $limit);
+ $result = $api_instance->getSchemaByName($accept, $schemaName);
print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling EntitiesAndRelationshipsApi->getTopologyEntityTypes: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling SchemasApi->getSchemaByName: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-perl">
+ <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::EntitiesAndRelationshipsApi;
+use WWW::OPenAPIClient::SchemasApi;
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::EntitiesAndRelationshipsApi->new();
+my $api_instance = WWW::OPenAPIClient::SchemasApi->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.
+my $schemaName = schemaName_example; # String |
eval {
- my $result = $api_instance->getTopologyEntityTypes(accept => $accept, domainName => $domainName, offset => $offset, limit => $limit);
+ my $result = $api_instance->getSchemaByName(accept => $accept, schemaName => $schemaName);
print Dumper($result);
};
if ($@) {
- warn "Exception when calling EntitiesAndRelationshipsApi->getTopologyEntityTypes: $@\n";
+ warn "Exception when calling SchemasApi->getSchemaByName: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-python">
+ <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import openapi_client
from pprint import pprint
# Create an instance of the API class
-api_instance = openapi_client.EntitiesAndRelationshipsApi()
+api_instance = openapi_client.SchemasApi()
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)
+schemaName = schemaName_example # String | (default to o-ran-smo-teiv-ran)
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)
+ # 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 EntitiesAndRelationshipsApi->getTopologyEntityTypes: %s\n" % e)</code></pre>
+ print("Exception when calling SchemasApi->getSchemaByName: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyEntityTypes-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate EntitiesAndRelationshipsApi;
+ <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate SchemasApi;
pub fn main() {
let accept = application/json; // String
- let domainName = domainName_example; // String
- let offset = 56; // Integer
- let limit = 56; // Integer
+ let schemaName = schemaName_example; // String
- let mut context = EntitiesAndRelationshipsApi::Context::default();
- let result = client.getTopologyEntityTypes(accept, domainName, offset, limit, &context).wait();
+ let mut context = SchemasApi::Context::default();
+ let result = client.getSchemaByName(accept, schemaName, &context).wait();
println!("{:?}", result);
}
<th width="150px">Name</th>
<th>Description</th>
</tr>
- <tr><td style="width:150px;">domainName*</td>
+ <tr><td style="width:150px;">schemaName*</td>
<td>
- <div id="d2e199_getTopologyEntityTypes_domainName">
+ <div id="d2e199_getSchemaByName_schemaName">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
String
</span>
- <div class="inner description marked">
-domain name
- </div>
</div>
<div class="inner required">
Required
<td>
- <div id="d2e199_getTopologyEntityTypes_accept">
+ <div id="d2e199_getSchemaByName_accept">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
- <div class="methodsubtabletitle">Query parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">offset</td>
-<td>
+ <h2>Responses</h2>
+ <h3 id="examples-Schemas-getSchemaByName-title-200"></h3>
+ <p id="examples-Schemas-getSchemaByName-description-200" class="marked"></p>
+ <script>
+ var responseSchemas200_description = `OK`;
+ var responseSchemas200_description_break = responseSchemas200_description.indexOf('\n');
+ if (responseSchemas200_description_break == -1) {
+ $("#examples-Schemas-getSchemaByName-title-200").text("Status: 200 - " + responseSchemas200_description);
+ } else {
+ $("#examples-Schemas-getSchemaByName-title-200").text("Status: 200 - " + responseSchemas200_description.substring(0, responseSchemas200_description_break));
+ $("#examples-Schemas-getSchemaByName-description-200").html(responseSchemas200_description.substring(responseSchemas200_description_break));
+ }
+ </script>
- <div id="d2e199_getTopologyEntityTypes_offset">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- Integer
- </span>
- <div class="inner description marked">
-Pagination offset.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
+ <ul id="responses-detail-Schemas-getSchemaByName-200" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-Schemas-getSchemaByName-200-schema">Schema</a>
+ </li>
- <tr><td style="width:150px;">limit</td>
-<td>
- <div id="d2e199_getTopologyEntityTypes_limit">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- Integer
- </span>
- <div class="inner description marked">
-Result limiter.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
+ </ul>
- </table>
- <h2>Responses</h2>
- <h3 id="examples-EntitiesAndRelationships-getTopologyEntityTypes-title-200"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyEntityTypes-description-200" class="marked"></p>
- <script>
- var responseEntitiesAndRelationships200_description = `OK`;
- var responseEntitiesAndRelationships200_description_break = responseEntitiesAndRelationships200_description.indexOf('\n');
- if (responseEntitiesAndRelationships200_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
+ <div class="tab-content" id="responses-Schemas-getSchemaByName-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-getSchemaByName-200-schema">
+ <div id="responses-Schemas-getSchemaByName-schema-200" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "OK",
+ "content" : {
+ "text/plain" : {
+ "schema" : {
+ "type" : "string"
+ },
+ "examples" : {
+ "schema" : {
+ "$ref" : "#/components/examples/SchemaResponseExample"
+ }
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-Schemas-getSchemaByName-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-getSchemaByName-schema-200');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-Schemas-getSchemaByName-200-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-Schemas-getSchemaByName-title-400"></h3>
+ <p id="examples-Schemas-getSchemaByName-description-400" class="marked"></p>
+ <script>
+ var responseSchemas400_description = `Bad Request`;
+ var responseSchemas400_description_break = responseSchemas400_description.indexOf('\n');
+ if (responseSchemas400_description_break == -1) {
+ $("#examples-Schemas-getSchemaByName-title-400").text("Status: 400 - " + responseSchemas400_description);
} else {
- $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
+ $("#examples-Schemas-getSchemaByName-title-400").text("Status: 400 - " + responseSchemas400_description.substring(0, responseSchemas400_description_break));
+ $("#examples-Schemas-getSchemaByName-description-400").html(responseSchemas400_description.substring(responseSchemas400_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyEntityTypes-200" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-getSchemaByName-400" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyEntityTypes-200-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-getSchemaByName-400-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-200-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-200" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-getSchemaByName-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-getSchemaByName-400-schema">
+ <div id="responses-Schemas-getSchemaByName-schema-400" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "OK",
+ "description" : "Bad Request",
"content" : {
- "application/json" : {
+ "application/problem+json" : {
"schema" : {
- "$ref" : "#/components/schemas/EntityTypes"
+ "$ref" : "#/components/schemas/ErrorMessage"
},
- "examples" : {
- "entityTypes" : {
- "$ref" : "#/components/examples/EntityTypesResponseExample"
- }
+ "example" : {
+ "status" : "400",
+ "title" : "Bad Request",
+ "details" : "The provided request is not valid"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-200');
+ $('#responses-Schemas-getSchemaByName-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-getSchemaByName-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyEntityTypes-200-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-getSchemaByName-400-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getTopologyEntityTypes-title-400"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyEntityTypes-description-400" class="marked"></p>
+ <h3 id="examples-Schemas-getSchemaByName-title-401"></h3>
+ <p id="examples-Schemas-getSchemaByName-description-401" class="marked"></p>
<script>
- var responseEntitiesAndRelationships400_description = `Bad Request`;
- var responseEntitiesAndRelationships400_description_break = responseEntitiesAndRelationships400_description.indexOf('\n');
- if (responseEntitiesAndRelationships400_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
+ var responseSchemas401_description = `Unauthorized`;
+ var responseSchemas401_description_break = responseSchemas401_description.indexOf('\n');
+ if (responseSchemas401_description_break == -1) {
+ $("#examples-Schemas-getSchemaByName-title-401").text("Status: 401 - " + responseSchemas401_description);
} else {
- $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
+ $("#examples-Schemas-getSchemaByName-title-401").text("Status: 401 - " + responseSchemas401_description.substring(0, responseSchemas401_description_break));
+ $("#examples-Schemas-getSchemaByName-description-401").html(responseSchemas401_description.substring(responseSchemas401_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyEntityTypes-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-getSchemaByName-401" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyEntityTypes-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-getSchemaByName-401-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-400-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-getSchemaByName-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-getSchemaByName-401-schema">
+ <div id="responses-Schemas-getSchemaByName-schema-401" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Bad Request",
+ "description" : "Unauthorized",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
- "status" : "400",
- "title" : "Bad Request",
- "details" : "The provided request is not valid"
+ "status" : "401",
+ "title" : "Unauthorized request",
+ "details" : "This request is unauthorized"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-400');
+ $('#responses-Schemas-getSchemaByName-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-getSchemaByName-schema-401');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyEntityTypes-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-getSchemaByName-401-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getTopologyEntityTypes-title-401"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyEntityTypes-description-401" class="marked"></p>
+ <h3 id="examples-Schemas-getSchemaByName-title-403"></h3>
+ <p id="examples-Schemas-getSchemaByName-description-403" class="marked"></p>
<script>
- var responseEntitiesAndRelationships401_description = `Unauthorized`;
- var responseEntitiesAndRelationships401_description_break = responseEntitiesAndRelationships401_description.indexOf('\n');
- if (responseEntitiesAndRelationships401_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
+ var responseSchemas403_description = `Forbidden`;
+ var responseSchemas403_description_break = responseSchemas403_description.indexOf('\n');
+ if (responseSchemas403_description_break == -1) {
+ $("#examples-Schemas-getSchemaByName-title-403").text("Status: 403 - " + responseSchemas403_description);
} else {
- $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
+ $("#examples-Schemas-getSchemaByName-title-403").text("Status: 403 - " + responseSchemas403_description.substring(0, responseSchemas403_description_break));
+ $("#examples-Schemas-getSchemaByName-description-403").html(responseSchemas403_description.substring(responseSchemas403_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyEntityTypes-401" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-getSchemaByName-403" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyEntityTypes-401-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-getSchemaByName-403-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-401-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-401-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-401" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-getSchemaByName-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-getSchemaByName-403-schema">
+ <div id="responses-Schemas-getSchemaByName-schema-403" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Unauthorized",
+ "description" : "Forbidden",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
- "status" : "401",
- "title" : "Unauthorized request",
- "details" : "This request is unauthorized"
+ "status" : "403",
+ "title" : "Request Forbidden",
+ "details" : "This request is forbidden"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-401-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-401');
+ $('#responses-Schemas-getSchemaByName-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-getSchemaByName-schema-403');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyEntityTypes-401-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-getSchemaByName-403-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getTopologyEntityTypes-title-403"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyEntityTypes-description-403" class="marked"></p>
+ <h3 id="examples-Schemas-getSchemaByName-title-404"></h3>
+ <p id="examples-Schemas-getSchemaByName-description-404" class="marked"></p>
<script>
- var responseEntitiesAndRelationships403_description = `Forbidden`;
- var responseEntitiesAndRelationships403_description_break = responseEntitiesAndRelationships403_description.indexOf('\n');
- if (responseEntitiesAndRelationships403_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
+ var responseSchemas404_description = `Not Found`;
+ var responseSchemas404_description_break = responseSchemas404_description.indexOf('\n');
+ if (responseSchemas404_description_break == -1) {
+ $("#examples-Schemas-getSchemaByName-title-404").text("Status: 404 - " + responseSchemas404_description);
} else {
- $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
+ $("#examples-Schemas-getSchemaByName-title-404").text("Status: 404 - " + responseSchemas404_description.substring(0, responseSchemas404_description_break));
+ $("#examples-Schemas-getSchemaByName-description-404").html(responseSchemas404_description.substring(responseSchemas404_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyEntityTypes-403" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-getSchemaByName-404" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyEntityTypes-403-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-getSchemaByName-404-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-403-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-403-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-403" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-getSchemaByName-404-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-getSchemaByName-404-schema">
+ <div id="responses-Schemas-getSchemaByName-schema-404" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Forbidden",
+ "description" : "Not Found",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
- "status" : "403",
- "title" : "Request Forbidden",
- "details" : "This request is forbidden"
+ "status" : "404",
+ "title" : "Resource Not Found",
+ "details" : "The requested resource is not found"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-403-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-403');
+ $('#responses-Schemas-getSchemaByName-404-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-getSchemaByName-schema-404');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyEntityTypes-403-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-getSchemaByName-404-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getTopologyEntityTypes-title-500"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyEntityTypes-description-500" class="marked"></p>
+ <h3 id="examples-Schemas-getSchemaByName-title-500"></h3>
+ <p id="examples-Schemas-getSchemaByName-description-500" class="marked"></p>
<script>
- var responseEntitiesAndRelationships500_description = `Internal Server Error`;
- var responseEntitiesAndRelationships500_description_break = responseEntitiesAndRelationships500_description.indexOf('\n');
- if (responseEntitiesAndRelationships500_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description);
+ var responseSchemas500_description = `Internal Server Error`;
+ var responseSchemas500_description_break = responseSchemas500_description.indexOf('\n');
+ if (responseSchemas500_description_break == -1) {
+ $("#examples-Schemas-getSchemaByName-title-500").text("Status: 500 - " + responseSchemas500_description);
} else {
- $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description.substring(0, responseEntitiesAndRelationships500_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyEntityTypes-description-500").html(responseEntitiesAndRelationships500_description.substring(responseEntitiesAndRelationships500_description_break));
+ $("#examples-Schemas-getSchemaByName-title-500").text("Status: 500 - " + responseSchemas500_description.substring(0, responseSchemas500_description_break));
+ $("#examples-Schemas-getSchemaByName-description-500").html(responseSchemas500_description.substring(responseSchemas500_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyEntityTypes-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-getSchemaByName-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyEntityTypes-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-getSchemaByName-500-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyEntityTypes-500-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-getSchemaByName-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-getSchemaByName-500-schema">
+ <div id="responses-Schemas-getSchemaByName-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyEntityTypes-schema-500');
+ $('#responses-Schemas-getSchemaByName-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-getSchemaByName-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyEntityTypes-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-getSchemaByName-500-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- <div id="api-EntitiesAndRelationships-getTopologyRelationshipTypes">
- <article id="api-EntitiesAndRelationships-getTopologyRelationshipTypes-0" data-group="User" data-name="getTopologyRelationshipTypes" data-version="0">
+ <div id="api-Schemas-getSchemas">
+ <article id="api-Schemas-getSchemas-0" data-group="User" data-name="getSchemas" data-version="0">
<div class="pull-left">
- <h1>getTopologyRelationshipTypes</h1>
- <p>Get all the available topology relationship types.</p>
+ <h1>getSchemas</h1>
+ <p>Get a list of all schemas.</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Get all the available topology relationship types.</p>
+ <p class="marked">Get a list of all schemas.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/domains/{domainName}/relationship-types</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/schemas</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
- <li class="active"><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-curl">Curl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-java">Java</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-dart">Dart</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-csharp">C#</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-php">PHP</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-perl">Perl</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-python">Python</a></li>
- <li class=""><a href="#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-Schemas-getSchemas-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-Schemas-getSchemas-0-java">Java</a></li>
+ <li class=""><a href="#examples-Schemas-getSchemas-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-Schemas-getSchemas-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-Schemas-getSchemas-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-Schemas-getSchemas-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-Schemas-getSchemas-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-Schemas-getSchemas-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-Schemas-getSchemas-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-Schemas-getSchemas-0-php">PHP</a></li>
+ <li class=""><a href="#examples-Schemas-getSchemas-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-Schemas-getSchemas-0-python">Python</a></li>
+ <li class=""><a href="#examples-Schemas-getSchemas-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-curl">
+ <div class="tab-pane active" id="examples-Schemas-getSchemas-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X GET \
-H "Accept: application/json,application/problem+json" \
- "https://localhost/topology-inventory/v1alpha11/domains/{domainName}/relationship-types?offset=56&limit=56"
+ "https://localhost/topology-inventory/v1alpha11/schemas?domain=ran&offset=56&limit=56"
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-java">
+ <div class="tab-pane" id="examples-Schemas-getSchemas-0-java">
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
-import org.openapitools.client.api.EntitiesAndRelationshipsApi;
+import org.openapitools.client.api.SchemasApi;
import java.io.File;
import java.util.*;
-public class EntitiesAndRelationshipsApiExample {
+public class SchemasApiExample {
public static void main(String[] args) {
// Create an instance of the API class
- EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
+ SchemasApi apiInstance = new SchemasApi();
String accept = application/json; // String |
- String domainName = domainName_example; // String | domain name
+ String domain = ran; // String |
Integer offset = 56; // Integer | Pagination offset.
Integer limit = 56; // Integer | Result limiter.
try {
- RelationshipTypes result = apiInstance.getTopologyRelationshipTypes(accept, domainName, offset, limit);
+ SchemaList result = apiInstance.getSchemas(accept, domain, offset, limit);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyRelationshipTypes");
+ System.err.println("Exception when calling SchemasApi#getSchemas");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-dart">
+ <div class="tab-pane" id="examples-Schemas-getSchemas-0-dart">
<pre class="prettyprint"><code class="language-dart">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 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.getTopologyRelationshipTypes(accept, domainName, offset, limit);
+ final result = await api_instance.getSchemas(accept, domain, offset, limit);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->getTopologyRelationshipTypes: $e\n');
+ print('Exception when calling DefaultApi->getSchemas: $e\n');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.EntitiesAndRelationshipsApi;
+ <div class="tab-pane" id="examples-Schemas-getSchemas-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.SchemasApi;
-public class EntitiesAndRelationshipsApiExample {
+public class SchemasApiExample {
public static void main(String[] args) {
- EntitiesAndRelationshipsApi apiInstance = new EntitiesAndRelationshipsApi();
+ SchemasApi apiInstance = new SchemasApi();
String accept = application/json; // String |
- String domainName = domainName_example; // String | domain name
+ String domain = ran; // String |
Integer offset = 56; // Integer | Pagination offset.
Integer limit = 56; // Integer | Result limiter.
try {
- RelationshipTypes result = apiInstance.getTopologyRelationshipTypes(accept, domainName, offset, limit);
+ SchemaList result = apiInstance.getSchemas(accept, domain, offset, limit);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling EntitiesAndRelationshipsApi#getTopologyRelationshipTypes");
+ System.err.println("Exception when calling SchemasApi#getSchemas");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-groovy">
+ <div class="tab-pane" id="examples-Schemas-getSchemas-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-objc">
+ <div class="tab-pane" id="examples-Schemas-getSchemas-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// Create an instance of the API class
-EntitiesAndRelationshipsApi *apiInstance = [[EntitiesAndRelationshipsApi alloc] init];
+SchemasApi *apiInstance = [[SchemasApi alloc] init];
String *accept = application/json; // (default to application/json)
-String *domainName = domainName_example; // domain name (default to null)
+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 all the available topology relationship types.
-[apiInstance getTopologyRelationshipTypesWith:accept
- domainName:domainName
+// Get a list of all schemas.
+[apiInstance getSchemasWith:accept
+ domain:domain
offset:offset
limit:limit
- completionHandler: ^(RelationshipTypes output, NSError* error) {
+ completionHandler: ^(SchemaList output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-javascript">
- <pre class="prettyprint"><code class="language-js">var TopologyAndInventoryApi = require('topology_and_inventory_api');
+ <div class="tab-pane" id="examples-Schemas-getSchemas-0-javascript">
+ <pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
-var api = new TopologyAndInventoryApi.EntitiesAndRelationshipsApi()
+var api = new TopologyExposureAndInventoryApi.SchemasApi()
var accept = application/json; // {String}
-var domainName = domainName_example; // {String} domain name
var opts = {
+ 'domain': ran, // {String}
'offset': 56, // {Integer} Pagination offset.
'limit': 56 // {Integer} Result limiter.
};
console.log('API called successfully. Returned data: ' + data);
}
};
-api.getTopologyRelationshipTypes(accept, domainName, opts, callback);
+api.getSchemas(accept, opts, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-angular">
+ <!--<div class="tab-pane" id="examples-Schemas-getSchemas-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-csharp">
+ <div class="tab-pane" id="examples-Schemas-getSchemas-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class getTopologyRelationshipTypesExample
+ public class getSchemasExample
{
public void main()
{
// Create an instance of the API class
- var apiInstance = new EntitiesAndRelationshipsApi();
+ var apiInstance = new SchemasApi();
var accept = application/json; // String | (default to application/json)
- var domainName = domainName_example; // String | domain name (default to null)
+ 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 all the available topology relationship types.
- RelationshipTypes result = apiInstance.getTopologyRelationshipTypes(accept, domainName, offset, limit);
+ // 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 EntitiesAndRelationshipsApi.getTopologyRelationshipTypes: " + e.Message );
+ Debug.Print("Exception when calling SchemasApi.getSchemas: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-php">
+ <div class="tab-pane" id="examples-Schemas-getSchemas-0-php">
<pre class="prettyprint"><code class="language-php"><?php
require_once(__DIR__ . '/vendor/autoload.php');
// Create an instance of the API class
-$api_instance = new OpenAPITools\Client\Api\EntitiesAndRelationshipsApi();
+$api_instance = new OpenAPITools\Client\Api\SchemasApi();
$accept = application/json; // String |
-$domainName = domainName_example; // String | domain name
+$domain = ran; // String |
$offset = 56; // Integer | Pagination offset.
$limit = 56; // Integer | Result limiter.
try {
- $result = $api_instance->getTopologyRelationshipTypes($accept, $domainName, $offset, $limit);
+ $result = $api_instance->getSchemas($accept, $domain, $offset, $limit);
print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling EntitiesAndRelationshipsApi->getTopologyRelationshipTypes: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling SchemasApi->getSchemas: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-perl">
+ <div class="tab-pane" id="examples-Schemas-getSchemas-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::EntitiesAndRelationshipsApi;
+use WWW::OPenAPIClient::SchemasApi;
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::EntitiesAndRelationshipsApi->new();
+my $api_instance = WWW::OPenAPIClient::SchemasApi->new();
my $accept = application/json; # String |
-my $domainName = domainName_example; # String | domain name
+my $domain = ran; # String |
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);
+ my $result = $api_instance->getSchemas(accept => $accept, domain => $domain, offset => $offset, limit => $limit);
print Dumper($result);
};
if ($@) {
- warn "Exception when calling EntitiesAndRelationshipsApi->getTopologyRelationshipTypes: $@\n";
+ warn "Exception when calling SchemasApi->getSchemas: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-python">
+ <div class="tab-pane" id="examples-Schemas-getSchemas-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import openapi_client
from pprint import pprint
# Create an instance of the API class
-api_instance = openapi_client.EntitiesAndRelationshipsApi()
+api_instance = openapi_client.SchemasApi()
accept = application/json # String | (default to application/json)
-domainName = domainName_example # String | domain name (default to null)
+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 all the available topology relationship types.
- api_response = api_instance.get_topology_relationship_types(accept, domainName, offset=offset, limit=limit)
+ # 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 EntitiesAndRelationshipsApi->getTopologyRelationshipTypes: %s\n" % e)</code></pre>
+ print("Exception when calling SchemasApi->getSchemas: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate EntitiesAndRelationshipsApi;
+ <div class="tab-pane" id="examples-Schemas-getSchemas-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate SchemasApi;
pub fn main() {
let accept = application/json; // String
- let domainName = domainName_example; // String
+ let domain = ran; // String
let offset = 56; // Integer
let limit = 56; // Integer
- let mut context = EntitiesAndRelationshipsApi::Context::default();
- let result = client.getTopologyRelationshipTypes(accept, domainName, offset, limit, &context).wait();
+ let mut context = SchemasApi::Context::default();
+ let result = client.getSchemas(accept, domain, offset, limit, &context).wait();
println!("{:?}", result);
}
<h2>Parameters</h2>
- <div class="methodsubtabletitle">Path parameters</div>
+
+ <div class="methodsubtabletitle">Header parameters</div>
<table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">domainName*</td>
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">Accept*</td>
<td>
- <div id="d2e199_getTopologyRelationshipTypes_domainName">
+ <div id="d2e199_getSchemas_accept">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
String
</span>
- <div class="inner description marked">
-domain name
- </div>
</div>
<div class="inner required">
Required
</table>
- <div class="methodsubtabletitle">Header parameters</div>
+
+
+ <div class="methodsubtabletitle">Query parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
- <tr><td style="width:150px;">Accept*</td>
+ <tr><td style="width:150px;">domain</td>
<td>
- <div id="d2e199_getTopologyRelationshipTypes_accept">
+ <div id="d2e199_getSchemas_domain">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
</span>
</div>
- <div class="inner required">
- Required
- </div>
</div>
</div>
</td>
</tr>
- </table>
-
-
-
- <div class="methodsubtabletitle">Query parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
<tr><td style="width:150px;">offset</td>
<td>
- <div id="d2e199_getTopologyRelationshipTypes_offset">
+ <div id="d2e199_getSchemas_offset">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
<td>
- <div id="d2e199_getTopologyRelationshipTypes_limit">
+ <div id="d2e199_getSchemas_limit">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
</table>
<h2>Responses</h2>
- <h3 id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-200"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-200" class="marked"></p>
+ <h3 id="examples-Schemas-getSchemas-title-200"></h3>
+ <p id="examples-Schemas-getSchemas-description-200" class="marked"></p>
<script>
- var responseEntitiesAndRelationships200_description = `OK`;
- var responseEntitiesAndRelationships200_description_break = responseEntitiesAndRelationships200_description.indexOf('\n');
- if (responseEntitiesAndRelationships200_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description);
+ var responseSchemas200_description = `OK`;
+ var responseSchemas200_description_break = responseSchemas200_description.indexOf('\n');
+ if (responseSchemas200_description_break == -1) {
+ $("#examples-Schemas-getSchemas-title-200").text("Status: 200 - " + responseSchemas200_description);
} else {
- $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-200").text("Status: 200 - " + responseEntitiesAndRelationships200_description.substring(0, responseEntitiesAndRelationships200_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-200").html(responseEntitiesAndRelationships200_description.substring(responseEntitiesAndRelationships200_description_break));
+ $("#examples-Schemas-getSchemas-title-200").text("Status: 200 - " + responseSchemas200_description.substring(0, responseSchemas200_description_break));
+ $("#examples-Schemas-getSchemas-description-200").html(responseSchemas200_description.substring(responseSchemas200_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyRelationshipTypes-200" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-getSchemas-200" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-200-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-getSchemas-200-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-200-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-200" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-getSchemas-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-getSchemas-200-schema">
+ <div id="responses-Schemas-getSchemas-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/RelationshipTypes"
+ "$ref" : "#/components/schemas/SchemaList"
},
"examples" : {
- "relationshipTypes" : {
- "$ref" : "#/components/examples/RelationshipTypesResponseExample"
+ "schemas" : {
+ "$ref" : "#/components/examples/SchemasResponseExample"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-200');
+ $('#responses-Schemas-getSchemas-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-getSchemas-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyRelationshipTypes-200-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-getSchemas-200-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-400"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-400" class="marked"></p>
+ <h3 id="examples-Schemas-getSchemas-title-400"></h3>
+ <p id="examples-Schemas-getSchemas-description-400" class="marked"></p>
<script>
- var responseEntitiesAndRelationships400_description = `Bad Request`;
- var responseEntitiesAndRelationships400_description_break = responseEntitiesAndRelationships400_description.indexOf('\n');
- if (responseEntitiesAndRelationships400_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description);
+ var responseSchemas400_description = `Bad Request`;
+ var responseSchemas400_description_break = responseSchemas400_description.indexOf('\n');
+ if (responseSchemas400_description_break == -1) {
+ $("#examples-Schemas-getSchemas-title-400").text("Status: 400 - " + responseSchemas400_description);
} else {
- $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-400").text("Status: 400 - " + responseEntitiesAndRelationships400_description.substring(0, responseEntitiesAndRelationships400_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-400").html(responseEntitiesAndRelationships400_description.substring(responseEntitiesAndRelationships400_description_break));
+ $("#examples-Schemas-getSchemas-title-400").text("Status: 400 - " + responseSchemas400_description.substring(0, responseSchemas400_description_break));
+ $("#examples-Schemas-getSchemas-description-400").html(responseSchemas400_description.substring(responseSchemas400_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyRelationshipTypes-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-getSchemas-400" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-getSchemas-400-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-400-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-getSchemas-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-getSchemas-400-schema">
+ <div id="responses-Schemas-getSchemas-schema-400" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-400');
+ $('#responses-Schemas-getSchemas-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-getSchemas-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyRelationshipTypes-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-getSchemas-400-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-401"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-401" class="marked"></p>
+ <h3 id="examples-Schemas-getSchemas-title-401"></h3>
+ <p id="examples-Schemas-getSchemas-description-401" class="marked"></p>
<script>
- var responseEntitiesAndRelationships401_description = `Unauthorized`;
- var responseEntitiesAndRelationships401_description_break = responseEntitiesAndRelationships401_description.indexOf('\n');
- if (responseEntitiesAndRelationships401_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description);
+ var responseSchemas401_description = `Unauthorized`;
+ var responseSchemas401_description_break = responseSchemas401_description.indexOf('\n');
+ if (responseSchemas401_description_break == -1) {
+ $("#examples-Schemas-getSchemas-title-401").text("Status: 401 - " + responseSchemas401_description);
} else {
- $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-401").text("Status: 401 - " + responseEntitiesAndRelationships401_description.substring(0, responseEntitiesAndRelationships401_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-401").html(responseEntitiesAndRelationships401_description.substring(responseEntitiesAndRelationships401_description_break));
+ $("#examples-Schemas-getSchemas-title-401").text("Status: 401 - " + responseSchemas401_description.substring(0, responseSchemas401_description_break));
+ $("#examples-Schemas-getSchemas-description-401").html(responseSchemas401_description.substring(responseSchemas401_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyRelationshipTypes-401" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-getSchemas-401" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-401-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-getSchemas-401-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-401-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-401-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-401" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-getSchemas-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-getSchemas-401-schema">
+ <div id="responses-Schemas-getSchemas-schema-401" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-401-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-401');
+ $('#responses-Schemas-getSchemas-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-getSchemas-schema-401');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyRelationshipTypes-401-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-getSchemas-401-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-403"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-403" class="marked"></p>
+ <h3 id="examples-Schemas-getSchemas-title-403"></h3>
+ <p id="examples-Schemas-getSchemas-description-403" class="marked"></p>
<script>
- var responseEntitiesAndRelationships403_description = `Forbidden`;
- var responseEntitiesAndRelationships403_description_break = responseEntitiesAndRelationships403_description.indexOf('\n');
- if (responseEntitiesAndRelationships403_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description);
- } else {
- $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-403").text("Status: 403 - " + responseEntitiesAndRelationships403_description.substring(0, responseEntitiesAndRelationships403_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-403").html(responseEntitiesAndRelationships403_description.substring(responseEntitiesAndRelationships403_description_break));
+ var responseSchemas403_description = `Forbidden`;
+ var responseSchemas403_description_break = responseSchemas403_description.indexOf('\n');
+ if (responseSchemas403_description_break == -1) {
+ $("#examples-Schemas-getSchemas-title-403").text("Status: 403 - " + responseSchemas403_description);
+ } else {
+ $("#examples-Schemas-getSchemas-title-403").text("Status: 403 - " + responseSchemas403_description.substring(0, responseSchemas403_description_break));
+ $("#examples-Schemas-getSchemas-description-403").html(responseSchemas403_description.substring(responseSchemas403_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyRelationshipTypes-403" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-getSchemas-403" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-403-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-getSchemas-403-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-403-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-403-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-403" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-getSchemas-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-getSchemas-403-schema">
+ <div id="responses-Schemas-getSchemas-schema-403" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-403-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-403');
+ $('#responses-Schemas-getSchemas-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-getSchemas-schema-403');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyRelationshipTypes-403-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-getSchemas-403-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-500"></h3>
- <p id="examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-500" class="marked"></p>
+ <h3 id="examples-Schemas-getSchemas-title-500"></h3>
+ <p id="examples-Schemas-getSchemas-description-500" class="marked"></p>
<script>
- var responseEntitiesAndRelationships500_description = `Internal Server Error`;
- var responseEntitiesAndRelationships500_description_break = responseEntitiesAndRelationships500_description.indexOf('\n');
- if (responseEntitiesAndRelationships500_description_break == -1) {
- $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description);
+ var responseSchemas500_description = `Internal Server Error`;
+ var responseSchemas500_description_break = responseSchemas500_description.indexOf('\n');
+ if (responseSchemas500_description_break == -1) {
+ $("#examples-Schemas-getSchemas-title-500").text("Status: 500 - " + responseSchemas500_description);
} else {
- $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-title-500").text("Status: 500 - " + responseEntitiesAndRelationships500_description.substring(0, responseEntitiesAndRelationships500_description_break));
- $("#examples-EntitiesAndRelationships-getTopologyRelationshipTypes-description-500").html(responseEntitiesAndRelationships500_description.substring(responseEntitiesAndRelationships500_description_break));
+ $("#examples-Schemas-getSchemas-title-500").text("Status: 500 - " + responseSchemas500_description.substring(0, responseSchemas500_description_break));
+ $("#examples-Schemas-getSchemas-description-500").html(responseSchemas500_description.substring(responseSchemas500_description_break));
}
</script>
- <ul id="responses-detail-EntitiesAndRelationships-getTopologyRelationshipTypes-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-Schemas-getSchemas-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-Schemas-getSchemas-500-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-500-schema">
- <div id="responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-Schemas-getSchemas-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-Schemas-getSchemas-500-schema">
+ <div id="responses-Schemas-getSchemas-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-EntitiesAndRelationships-getTopologyRelationshipTypes-schema-500');
+ $('#responses-Schemas-getSchemas-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-Schemas-getSchemas-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-EntitiesAndRelationships-getTopologyRelationshipTypes-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-Schemas-getSchemas-500-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
</section>
- <section id="api-GeoQuery">
- <h1>GeoQuery</h1>
- <div id="api-GeoQuery-geoQueryTopologyAcrossDomains">
- <article id="api-GeoQuery-geoQueryTopologyAcrossDomains-0" data-group="User" data-name="geoQueryTopologyAcrossDomains" data-version="0">
+ <section id="api-TopologyGroups">
+ <h1>TopologyGroups</h1>
+ <div id="api-TopologyGroups-createGroup">
+ <article id="api-TopologyGroups-createGroup-0" data-group="User" data-name="createGroup" data-version="0">
<div class="pull-left">
- <h1>geoQueryTopologyAcrossDomains</h1>
- <p>Geo query topology entity or entities across topology domains.</p>
+ <h1>createGroup</h1>
+ <p>Create group.</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Geo query topology entity or entities across topology domains.</p>
+ <p class="marked">Create group.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/geo-queries</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/groups</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
- <li class="active"><a href="#examples-GeoQuery-geoQueryTopologyAcrossDomains-0-curl">Curl</a></li>
- <li class=""><a href="#examples-GeoQuery-geoQueryTopologyAcrossDomains-0-java">Java</a></li>
- <li class=""><a href="#examples-GeoQuery-geoQueryTopologyAcrossDomains-0-dart">Dart</a></li>
- <li class=""><a href="#examples-GeoQuery-geoQueryTopologyAcrossDomains-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-GeoQuery-geoQueryTopologyAcrossDomains-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-GeoQuery-geoQueryTopologyAcrossDomains-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-GeoQuery-geoQueryTopologyAcrossDomains-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-GeoQuery-geoQueryTopologyAcrossDomains-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-GeoQuery-geoQueryTopologyAcrossDomains-0-csharp">C#</a></li>
- <li class=""><a href="#examples-GeoQuery-geoQueryTopologyAcrossDomains-0-php">PHP</a></li>
- <li class=""><a href="#examples-GeoQuery-geoQueryTopologyAcrossDomains-0-perl">Perl</a></li>
- <li class=""><a href="#examples-GeoQuery-geoQueryTopologyAcrossDomains-0-python">Python</a></li>
- <li class=""><a href="#examples-GeoQuery-geoQueryTopologyAcrossDomains-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-TopologyGroups-createGroup-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-TopologyGroups-createGroup-0-java">Java</a></li>
+ <li class=""><a href="#examples-TopologyGroups-createGroup-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-TopologyGroups-createGroup-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-TopologyGroups-createGroup-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-TopologyGroups-createGroup-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-TopologyGroups-createGroup-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-TopologyGroups-createGroup-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-TopologyGroups-createGroup-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-TopologyGroups-createGroup-0-php">PHP</a></li>
+ <li class=""><a href="#examples-TopologyGroups-createGroup-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-TopologyGroups-createGroup-0-python">Python</a></li>
+ <li class=""><a href="#examples-TopologyGroups-createGroup-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-GeoQuery-geoQueryTopologyAcrossDomains-0-curl">
+ <div class="tab-pane active" id="examples-TopologyGroups-createGroup-0-curl">
<pre class="prettyprint"><code class="language-bsh">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" \
+ "https://localhost/topology-inventory/v1alpha11/groups" \
-d '{
- "query" : "query"
+ "groupName" : "groupName",
+ "criteria" : {
+ "resourceInstances" : [ "resourceInstances", "resourceInstances" ]
+ }
}'
</code></pre>
</div>
- <div class="tab-pane" id="examples-GeoQuery-geoQueryTopologyAcrossDomains-0-java">
+ <div class="tab-pane" id="examples-TopologyGroups-createGroup-0-java">
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
-import org.openapitools.client.api.GeoQueryApi;
+import org.openapitools.client.api.TopologyGroupsApi;
import java.io.File;
import java.util.*;
-public class GeoQueryApiExample {
+public class TopologyGroupsApiExample {
public static void main(String[] args) {
// Create an instance of the API class
- GeoQueryApi apiInstance = new GeoQueryApi();
+ TopologyGroupsApi apiInstance = new TopologyGroupsApi();
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.
+ Group group = ; // Group |
try {
- Object result = apiInstance.geoQueryTopologyAcrossDomains(accept, contentType, queryMessage, offset, limit);
+ GroupResponse result = apiInstance.createGroup(accept, contentType, group);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling GeoQueryApi#geoQueryTopologyAcrossDomains");
+ System.err.println("Exception when calling TopologyGroupsApi#createGroup");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-GeoQuery-geoQueryTopologyAcrossDomains-0-dart">
+ <div class="tab-pane" id="examples-TopologyGroups-createGroup-0-dart">
<pre class="prettyprint"><code class="language-dart">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.
+final Group group = new Group(); // Group |
try {
- final result = await api_instance.geoQueryTopologyAcrossDomains(accept, contentType, queryMessage, offset, limit);
+ final result = await api_instance.createGroup(accept, contentType, group);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->geoQueryTopologyAcrossDomains: $e\n');
+ print('Exception when calling DefaultApi->createGroup: $e\n');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-GeoQuery-geoQueryTopologyAcrossDomains-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.GeoQueryApi;
+ <div class="tab-pane" id="examples-TopologyGroups-createGroup-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.TopologyGroupsApi;
-public class GeoQueryApiExample {
+public class TopologyGroupsApiExample {
public static void main(String[] args) {
- GeoQueryApi apiInstance = new GeoQueryApi();
+ TopologyGroupsApi apiInstance = new TopologyGroupsApi();
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.
+ Group group = ; // Group |
try {
- Object result = apiInstance.geoQueryTopologyAcrossDomains(accept, contentType, queryMessage, offset, limit);
+ GroupResponse result = apiInstance.createGroup(accept, contentType, group);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling GeoQueryApi#geoQueryTopologyAcrossDomains");
+ System.err.println("Exception when calling TopologyGroupsApi#createGroup");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-GeoQuery-geoQueryTopologyAcrossDomains-0-groovy">
+ <div class="tab-pane" id="examples-TopologyGroups-createGroup-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-GeoQuery-geoQueryTopologyAcrossDomains-0-objc">
+ <div class="tab-pane" id="examples-TopologyGroups-createGroup-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// Create an instance of the API class
-GeoQueryApi *apiInstance = [[GeoQueryApi alloc] init];
+TopologyGroupsApi *apiInstance = [[TopologyGroupsApi 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)
+Group *group = ; //
-// Geo query topology entity or entities across topology domains.
-[apiInstance geoQueryTopologyAcrossDomainsWith:accept
+// Create group.
+[apiInstance createGroupWith:accept
contentType:contentType
- queryMessage:queryMessage
- offset:offset
- limit:limit
- completionHandler: ^(Object output, NSError* error) {
+ group:group
+ completionHandler: ^(GroupResponse output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-GeoQuery-geoQueryTopologyAcrossDomains-0-javascript">
- <pre class="prettyprint"><code class="language-js">var TopologyAndInventoryApi = require('topology_and_inventory_api');
+ <div class="tab-pane" id="examples-TopologyGroups-createGroup-0-javascript">
+ <pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
-var api = new TopologyAndInventoryApi.GeoQueryApi()
+var api = new TopologyExposureAndInventoryApi.TopologyGroupsApi()
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 group = ; // {Group}
var callback = function(error, data, response) {
if (error) {
console.log('API called successfully. Returned data: ' + data);
}
};
-api.geoQueryTopologyAcrossDomains(accept, contentType, queryMessage, opts, callback);
+api.createGroup(accept, contentType, group, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-GeoQuery-geoQueryTopologyAcrossDomains-0-angular">
+ <!--<div class="tab-pane" id="examples-TopologyGroups-createGroup-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-GeoQuery-geoQueryTopologyAcrossDomains-0-csharp">
+ <div class="tab-pane" id="examples-TopologyGroups-createGroup-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class geoQueryTopologyAcrossDomainsExample
+ public class createGroupExample
{
public void main()
{
// Create an instance of the API class
- var apiInstance = new GeoQueryApi();
+ var apiInstance = new TopologyGroupsApi();
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)
+ var group = new Group(); // Group |
try {
- // Geo query topology entity or entities across topology domains.
- Object result = apiInstance.geoQueryTopologyAcrossDomains(accept, contentType, queryMessage, offset, limit);
+ // Create group.
+ GroupResponse result = apiInstance.createGroup(accept, contentType, group);
Debug.WriteLine(result);
} catch (Exception e) {
- Debug.Print("Exception when calling GeoQueryApi.geoQueryTopologyAcrossDomains: " + e.Message );
+ Debug.Print("Exception when calling TopologyGroupsApi.createGroup: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-GeoQuery-geoQueryTopologyAcrossDomains-0-php">
+ <div class="tab-pane" id="examples-TopologyGroups-createGroup-0-php">
<pre class="prettyprint"><code class="language-php"><?php
require_once(__DIR__ . '/vendor/autoload.php');
// Create an instance of the API class
-$api_instance = new OpenAPITools\Client\Api\GeoQueryApi();
+$api_instance = new OpenAPITools\Client\Api\TopologyGroupsApi();
$accept = application/json; // String |
$contentType = application/json; // String |
-$queryMessage = ; // QueryMessage |
-$offset = 56; // Integer | Pagination offset.
-$limit = 56; // Integer | Result limiter.
+$group = ; // Group |
try {
- $result = $api_instance->geoQueryTopologyAcrossDomains($accept, $contentType, $queryMessage, $offset, $limit);
+ $result = $api_instance->createGroup($accept, $contentType, $group);
print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling GeoQueryApi->geoQueryTopologyAcrossDomains: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling TopologyGroupsApi->createGroup: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-GeoQuery-geoQueryTopologyAcrossDomains-0-perl">
+ <div class="tab-pane" id="examples-TopologyGroups-createGroup-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::GeoQueryApi;
+use WWW::OPenAPIClient::TopologyGroupsApi;
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::GeoQueryApi->new();
+my $api_instance = WWW::OPenAPIClient::TopologyGroupsApi->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.
+my $group = WWW::OPenAPIClient::Object::Group->new(); # Group |
eval {
- my $result = $api_instance->geoQueryTopologyAcrossDomains(accept => $accept, contentType => $contentType, queryMessage => $queryMessage, offset => $offset, limit => $limit);
+ my $result = $api_instance->createGroup(accept => $accept, contentType => $contentType, group => $group);
print Dumper($result);
};
if ($@) {
- warn "Exception when calling GeoQueryApi->geoQueryTopologyAcrossDomains: $@\n";
+ warn "Exception when calling TopologyGroupsApi->createGroup: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-GeoQuery-geoQueryTopologyAcrossDomains-0-python">
+ <div class="tab-pane" id="examples-TopologyGroups-createGroup-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import openapi_client
from pprint import pprint
# Create an instance of the API class
-api_instance = openapi_client.GeoQueryApi()
+api_instance = openapi_client.TopologyGroupsApi()
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)
+group = # Group |
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)
+ # Create group.
+ api_response = api_instance.create_group(accept, contentType, group)
pprint(api_response)
except ApiException as e:
- print("Exception when calling GeoQueryApi->geoQueryTopologyAcrossDomains: %s\n" % e)</code></pre>
+ print("Exception when calling TopologyGroupsApi->createGroup: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-GeoQuery-geoQueryTopologyAcrossDomains-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate GeoQueryApi;
+ <div class="tab-pane" id="examples-TopologyGroups-createGroup-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate TopologyGroupsApi;
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 group = ; // Group
- let mut context = GeoQueryApi::Context::default();
- let result = client.geoQueryTopologyAcrossDomains(accept, contentType, queryMessage, offset, limit, &context).wait();
+ let mut context = TopologyGroupsApi::Context::default();
+ let result = client.createGroup(accept, contentType, group, &context).wait();
println!("{:?}", result);
}
<td>
- <div id="d2e199_geoQueryTopologyAcrossDomains_accept">
+ <div id="d2e199_createGroup_accept">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
<td>
- <div id="d2e199_geoQueryTopologyAcrossDomains_contentType">
+ <div id="d2e199_createGroup_contentType">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
<th width="150px">Name</th>
<th>Description</th>
</tr>
- <tr><td style="width:150px;">queryMessage <span style="color:red;">*</span></td>
+ <tr><td style="width:150px;">group <span style="color:red;">*</span></td>
<td>
<p class="marked"></p>
<script>
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/QueryMessage"
+ "$ref" : "#/components/schemas/Group"
},
"examples" : {
- "geoQuery" : {
- "$ref" : "#/components/examples/QueryMessageExample"
+ "dynamicGroup" : {
+ "$ref" : "#/components/examples/DynamicGroupExample"
+ },
+ "staticGroup" : {
+ "$ref" : "#/components/examples/StaticGroupExample"
}
}
}
}
var view = new JSONSchemaView(schema,2,{isBodyParam: true});
- var result = $('#d2e199_geoQueryTopologyAcrossDomains_queryMessage');
+ var result = $('#d2e199_createGroup_group');
result.empty();
result.append(view.render());
});
</script>
-<div id="d2e199_geoQueryTopologyAcrossDomains_queryMessage"></div>
+<div id="d2e199_createGroup_group"></div>
</td>
</tr>
</table>
- <div class="methodsubtabletitle">Query parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">offset</td>
-<td>
-
-
- <div id="d2e199_geoQueryTopologyAcrossDomains_offset">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- Integer
- </span>
-
- <div class="inner description marked">
-Pagination offset.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- <tr><td style="width:150px;">limit</td>
-<td>
-
-
- <div id="d2e199_geoQueryTopologyAcrossDomains_limit">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- Integer
- </span>
-
- <div class="inner description marked">
-Result limiter.
- </div>
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- </table>
<h2>Responses</h2>
- <h3 id="examples-GeoQuery-geoQueryTopologyAcrossDomains-title-200"></h3>
- <p id="examples-GeoQuery-geoQueryTopologyAcrossDomains-description-200" class="marked"></p>
+ <h3 id="examples-TopologyGroups-createGroup-title-201"></h3>
+ <p id="examples-TopologyGroups-createGroup-description-201" class="marked"></p>
<script>
- var responseGeoQuery200_description = `OK`;
- var responseGeoQuery200_description_break = responseGeoQuery200_description.indexOf('\n');
- if (responseGeoQuery200_description_break == -1) {
- $("#examples-GeoQuery-geoQueryTopologyAcrossDomains-title-200").text("Status: 200 - " + responseGeoQuery200_description);
+ var responseTopologyGroups201_description = `Created`;
+ var responseTopologyGroups201_description_break = responseTopologyGroups201_description.indexOf('\n');
+ if (responseTopologyGroups201_description_break == -1) {
+ $("#examples-TopologyGroups-createGroup-title-201").text("Status: 201 - " + responseTopologyGroups201_description);
} else {
- $("#examples-GeoQuery-geoQueryTopologyAcrossDomains-title-200").text("Status: 200 - " + responseGeoQuery200_description.substring(0, responseGeoQuery200_description_break));
- $("#examples-GeoQuery-geoQueryTopologyAcrossDomains-description-200").html(responseGeoQuery200_description.substring(responseGeoQuery200_description_break));
+ $("#examples-TopologyGroups-createGroup-title-201").text("Status: 201 - " + responseTopologyGroups201_description.substring(0, responseTopologyGroups201_description_break));
+ $("#examples-TopologyGroups-createGroup-description-201").html(responseTopologyGroups201_description.substring(responseTopologyGroups201_description_break));
}
</script>
- <ul id="responses-detail-GeoQuery-geoQueryTopologyAcrossDomains-200" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-TopologyGroups-createGroup-201" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-GeoQuery-geoQueryTopologyAcrossDomains-200-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-TopologyGroups-createGroup-201-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-GeoQuery-geoQueryTopologyAcrossDomains-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-GeoQuery-geoQueryTopologyAcrossDomains-200-schema">
- <div id="responses-GeoQuery-geoQueryTopologyAcrossDomains-schema-200" class="exampleStyle">
+ <div class="tab-content" id="responses-TopologyGroups-createGroup-201-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-TopologyGroups-createGroup-201-schema">
+ <div id="responses-TopologyGroups-createGroup-schema-201" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "OK",
+ "description" : "Created",
"content" : {
"application/json" : {
"schema" : {
- "type" : "object"
+ "$ref" : "#/components/schemas/GroupResponse"
},
"examples" : {
- "geoQueryResponse" : {
- "$ref" : "#/components/examples/QueryResponseExample"
+ "group" : {
+ "$ref" : "#/components/examples/GroupResponseExample"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-GeoQuery-geoQueryTopologyAcrossDomains-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-GeoQuery-geoQueryTopologyAcrossDomains-schema-200');
+ $('#responses-TopologyGroups-createGroup-201-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-TopologyGroups-createGroup-schema-201');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-GeoQuery-geoQueryTopologyAcrossDomains-200-schema-data' type='hidden' value=''></input>
+ <input id='responses-TopologyGroups-createGroup-201-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-GeoQuery-geoQueryTopologyAcrossDomains-title-400"></h3>
- <p id="examples-GeoQuery-geoQueryTopologyAcrossDomains-description-400" class="marked"></p>
+ <h3 id="examples-TopologyGroups-createGroup-title-400"></h3>
+ <p id="examples-TopologyGroups-createGroup-description-400" class="marked"></p>
<script>
- var responseGeoQuery400_description = `Bad Request`;
- var responseGeoQuery400_description_break = responseGeoQuery400_description.indexOf('\n');
- if (responseGeoQuery400_description_break == -1) {
- $("#examples-GeoQuery-geoQueryTopologyAcrossDomains-title-400").text("Status: 400 - " + responseGeoQuery400_description);
+ var responseTopologyGroups400_description = `Bad Request`;
+ var responseTopologyGroups400_description_break = responseTopologyGroups400_description.indexOf('\n');
+ if (responseTopologyGroups400_description_break == -1) {
+ $("#examples-TopologyGroups-createGroup-title-400").text("Status: 400 - " + responseTopologyGroups400_description);
} else {
- $("#examples-GeoQuery-geoQueryTopologyAcrossDomains-title-400").text("Status: 400 - " + responseGeoQuery400_description.substring(0, responseGeoQuery400_description_break));
- $("#examples-GeoQuery-geoQueryTopologyAcrossDomains-description-400").html(responseGeoQuery400_description.substring(responseGeoQuery400_description_break));
+ $("#examples-TopologyGroups-createGroup-title-400").text("Status: 400 - " + responseTopologyGroups400_description.substring(0, responseTopologyGroups400_description_break));
+ $("#examples-TopologyGroups-createGroup-description-400").html(responseTopologyGroups400_description.substring(responseTopologyGroups400_description_break));
}
</script>
- <ul id="responses-detail-GeoQuery-geoQueryTopologyAcrossDomains-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-TopologyGroups-createGroup-400" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-GeoQuery-geoQueryTopologyAcrossDomains-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-TopologyGroups-createGroup-400-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-GeoQuery-geoQueryTopologyAcrossDomains-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-GeoQuery-geoQueryTopologyAcrossDomains-400-schema">
- <div id="responses-GeoQuery-geoQueryTopologyAcrossDomains-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-TopologyGroups-createGroup-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-TopologyGroups-createGroup-400-schema">
+ <div id="responses-TopologyGroups-createGroup-schema-400" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-GeoQuery-geoQueryTopologyAcrossDomains-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-GeoQuery-geoQueryTopologyAcrossDomains-schema-400');
+ $('#responses-TopologyGroups-createGroup-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-TopologyGroups-createGroup-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-GeoQuery-geoQueryTopologyAcrossDomains-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-TopologyGroups-createGroup-400-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-GeoQuery-geoQueryTopologyAcrossDomains-title-401"></h3>
- <p id="examples-GeoQuery-geoQueryTopologyAcrossDomains-description-401" class="marked"></p>
+ <h3 id="examples-TopologyGroups-createGroup-title-401"></h3>
+ <p id="examples-TopologyGroups-createGroup-description-401" class="marked"></p>
<script>
- var responseGeoQuery401_description = `Unauthorized`;
- var responseGeoQuery401_description_break = responseGeoQuery401_description.indexOf('\n');
- if (responseGeoQuery401_description_break == -1) {
- $("#examples-GeoQuery-geoQueryTopologyAcrossDomains-title-401").text("Status: 401 - " + responseGeoQuery401_description);
+ var responseTopologyGroups401_description = `Unauthorized`;
+ var responseTopologyGroups401_description_break = responseTopologyGroups401_description.indexOf('\n');
+ if (responseTopologyGroups401_description_break == -1) {
+ $("#examples-TopologyGroups-createGroup-title-401").text("Status: 401 - " + responseTopologyGroups401_description);
} else {
- $("#examples-GeoQuery-geoQueryTopologyAcrossDomains-title-401").text("Status: 401 - " + responseGeoQuery401_description.substring(0, responseGeoQuery401_description_break));
- $("#examples-GeoQuery-geoQueryTopologyAcrossDomains-description-401").html(responseGeoQuery401_description.substring(responseGeoQuery401_description_break));
+ $("#examples-TopologyGroups-createGroup-title-401").text("Status: 401 - " + responseTopologyGroups401_description.substring(0, responseTopologyGroups401_description_break));
+ $("#examples-TopologyGroups-createGroup-description-401").html(responseTopologyGroups401_description.substring(responseTopologyGroups401_description_break));
}
</script>
- <ul id="responses-detail-GeoQuery-geoQueryTopologyAcrossDomains-401" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-TopologyGroups-createGroup-401" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-GeoQuery-geoQueryTopologyAcrossDomains-401-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-TopologyGroups-createGroup-401-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-GeoQuery-geoQueryTopologyAcrossDomains-401-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-GeoQuery-geoQueryTopologyAcrossDomains-401-schema">
- <div id="responses-GeoQuery-geoQueryTopologyAcrossDomains-schema-401" class="exampleStyle">
+ <div class="tab-content" id="responses-TopologyGroups-createGroup-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-TopologyGroups-createGroup-401-schema">
+ <div id="responses-TopologyGroups-createGroup-schema-401" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-GeoQuery-geoQueryTopologyAcrossDomains-401-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-GeoQuery-geoQueryTopologyAcrossDomains-schema-401');
+ $('#responses-TopologyGroups-createGroup-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-TopologyGroups-createGroup-schema-401');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-GeoQuery-geoQueryTopologyAcrossDomains-401-schema-data' type='hidden' value=''></input>
+ <input id='responses-TopologyGroups-createGroup-401-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-GeoQuery-geoQueryTopologyAcrossDomains-title-403"></h3>
- <p id="examples-GeoQuery-geoQueryTopologyAcrossDomains-description-403" class="marked"></p>
+ <h3 id="examples-TopologyGroups-createGroup-title-403"></h3>
+ <p id="examples-TopologyGroups-createGroup-description-403" class="marked"></p>
<script>
- var responseGeoQuery403_description = `Forbidden`;
- var responseGeoQuery403_description_break = responseGeoQuery403_description.indexOf('\n');
- if (responseGeoQuery403_description_break == -1) {
- $("#examples-GeoQuery-geoQueryTopologyAcrossDomains-title-403").text("Status: 403 - " + responseGeoQuery403_description);
+ var responseTopologyGroups403_description = `Forbidden`;
+ var responseTopologyGroups403_description_break = responseTopologyGroups403_description.indexOf('\n');
+ if (responseTopologyGroups403_description_break == -1) {
+ $("#examples-TopologyGroups-createGroup-title-403").text("Status: 403 - " + responseTopologyGroups403_description);
} else {
- $("#examples-GeoQuery-geoQueryTopologyAcrossDomains-title-403").text("Status: 403 - " + responseGeoQuery403_description.substring(0, responseGeoQuery403_description_break));
- $("#examples-GeoQuery-geoQueryTopologyAcrossDomains-description-403").html(responseGeoQuery403_description.substring(responseGeoQuery403_description_break));
+ $("#examples-TopologyGroups-createGroup-title-403").text("Status: 403 - " + responseTopologyGroups403_description.substring(0, responseTopologyGroups403_description_break));
+ $("#examples-TopologyGroups-createGroup-description-403").html(responseTopologyGroups403_description.substring(responseTopologyGroups403_description_break));
}
</script>
- <ul id="responses-detail-GeoQuery-geoQueryTopologyAcrossDomains-403" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-TopologyGroups-createGroup-403" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-GeoQuery-geoQueryTopologyAcrossDomains-403-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-TopologyGroups-createGroup-403-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-GeoQuery-geoQueryTopologyAcrossDomains-403-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-GeoQuery-geoQueryTopologyAcrossDomains-403-schema">
- <div id="responses-GeoQuery-geoQueryTopologyAcrossDomains-schema-403" class="exampleStyle">
+ <div class="tab-content" id="responses-TopologyGroups-createGroup-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-TopologyGroups-createGroup-403-schema">
+ <div id="responses-TopologyGroups-createGroup-schema-403" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-GeoQuery-geoQueryTopologyAcrossDomains-403-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-GeoQuery-geoQueryTopologyAcrossDomains-schema-403');
+ $('#responses-TopologyGroups-createGroup-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-TopologyGroups-createGroup-schema-403');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-GeoQuery-geoQueryTopologyAcrossDomains-403-schema-data' type='hidden' value=''></input>
+ <input id='responses-TopologyGroups-createGroup-403-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-GeoQuery-geoQueryTopologyAcrossDomains-title-409"></h3>
- <p id="examples-GeoQuery-geoQueryTopologyAcrossDomains-description-409" class="marked"></p>
+ <h3 id="examples-TopologyGroups-createGroup-title-409"></h3>
+ <p id="examples-TopologyGroups-createGroup-description-409" class="marked"></p>
<script>
- var responseGeoQuery409_description = `Conflict`;
- var responseGeoQuery409_description_break = responseGeoQuery409_description.indexOf('\n');
- if (responseGeoQuery409_description_break == -1) {
- $("#examples-GeoQuery-geoQueryTopologyAcrossDomains-title-409").text("Status: 409 - " + responseGeoQuery409_description);
+ var responseTopologyGroups409_description = `Conflict`;
+ var responseTopologyGroups409_description_break = responseTopologyGroups409_description.indexOf('\n');
+ if (responseTopologyGroups409_description_break == -1) {
+ $("#examples-TopologyGroups-createGroup-title-409").text("Status: 409 - " + responseTopologyGroups409_description);
} else {
- $("#examples-GeoQuery-geoQueryTopologyAcrossDomains-title-409").text("Status: 409 - " + responseGeoQuery409_description.substring(0, responseGeoQuery409_description_break));
- $("#examples-GeoQuery-geoQueryTopologyAcrossDomains-description-409").html(responseGeoQuery409_description.substring(responseGeoQuery409_description_break));
+ $("#examples-TopologyGroups-createGroup-title-409").text("Status: 409 - " + responseTopologyGroups409_description.substring(0, responseTopologyGroups409_description_break));
+ $("#examples-TopologyGroups-createGroup-description-409").html(responseTopologyGroups409_description.substring(responseTopologyGroups409_description_break));
}
</script>
- <ul id="responses-detail-GeoQuery-geoQueryTopologyAcrossDomains-409" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-TopologyGroups-createGroup-409" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-GeoQuery-geoQueryTopologyAcrossDomains-409-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-TopologyGroups-createGroup-409-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-GeoQuery-geoQueryTopologyAcrossDomains-409-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-GeoQuery-geoQueryTopologyAcrossDomains-409-schema">
- <div id="responses-GeoQuery-geoQueryTopologyAcrossDomains-schema-409" class="exampleStyle">
+ <div class="tab-content" id="responses-TopologyGroups-createGroup-409-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-TopologyGroups-createGroup-409-schema">
+ <div id="responses-TopologyGroups-createGroup-schema-409" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
- "status" : "409'",
+ "status" : "409",
"title" : "Conflicting request",
"details" : "The request cannot be processed as the resource is in use."
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-GeoQuery-geoQueryTopologyAcrossDomains-409-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-GeoQuery-geoQueryTopologyAcrossDomains-schema-409');
+ $('#responses-TopologyGroups-createGroup-409-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-TopologyGroups-createGroup-schema-409');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-GeoQuery-geoQueryTopologyAcrossDomains-409-schema-data' type='hidden' value=''></input>
+ <input id='responses-TopologyGroups-createGroup-409-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-GeoQuery-geoQueryTopologyAcrossDomains-title-500"></h3>
- <p id="examples-GeoQuery-geoQueryTopologyAcrossDomains-description-500" class="marked"></p>
+ <h3 id="examples-TopologyGroups-createGroup-title-500"></h3>
+ <p id="examples-TopologyGroups-createGroup-description-500" class="marked"></p>
<script>
- var responseGeoQuery500_description = `Internal Server Error`;
- var responseGeoQuery500_description_break = responseGeoQuery500_description.indexOf('\n');
- if (responseGeoQuery500_description_break == -1) {
- $("#examples-GeoQuery-geoQueryTopologyAcrossDomains-title-500").text("Status: 500 - " + responseGeoQuery500_description);
+ var responseTopologyGroups500_description = `Internal Server Error`;
+ var responseTopologyGroups500_description_break = responseTopologyGroups500_description.indexOf('\n');
+ if (responseTopologyGroups500_description_break == -1) {
+ $("#examples-TopologyGroups-createGroup-title-500").text("Status: 500 - " + responseTopologyGroups500_description);
} else {
- $("#examples-GeoQuery-geoQueryTopologyAcrossDomains-title-500").text("Status: 500 - " + responseGeoQuery500_description.substring(0, responseGeoQuery500_description_break));
- $("#examples-GeoQuery-geoQueryTopologyAcrossDomains-description-500").html(responseGeoQuery500_description.substring(responseGeoQuery500_description_break));
+ $("#examples-TopologyGroups-createGroup-title-500").text("Status: 500 - " + responseTopologyGroups500_description.substring(0, responseTopologyGroups500_description_break));
+ $("#examples-TopologyGroups-createGroup-description-500").html(responseTopologyGroups500_description.substring(responseTopologyGroups500_description_break));
}
</script>
- <ul id="responses-detail-GeoQuery-geoQueryTopologyAcrossDomains-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-TopologyGroups-createGroup-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-GeoQuery-geoQueryTopologyAcrossDomains-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-TopologyGroups-createGroup-500-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-GeoQuery-geoQueryTopologyAcrossDomains-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-GeoQuery-geoQueryTopologyAcrossDomains-500-schema">
- <div id="responses-GeoQuery-geoQueryTopologyAcrossDomains-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-TopologyGroups-createGroup-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-TopologyGroups-createGroup-500-schema">
+ <div id="responses-TopologyGroups-createGroup-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-GeoQuery-geoQueryTopologyAcrossDomains-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-GeoQuery-geoQueryTopologyAcrossDomains-schema-500');
+ $('#responses-TopologyGroups-createGroup-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-TopologyGroups-createGroup-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-GeoQuery-geoQueryTopologyAcrossDomains-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-TopologyGroups-createGroup-500-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- </section>
- <section id="api-Schemas">
- <h1>Schemas</h1>
- <div id="api-Schemas-createSchema">
- <article id="api-Schemas-createSchema-0" data-group="User" data-name="createSchema" data-version="0">
+ <div id="api-TopologyGroups-deleteGroup">
+ <article id="api-TopologyGroups-deleteGroup-0" data-group="User" data-name="deleteGroup" data-version="0">
<div class="pull-left">
- <h1>createSchema</h1>
- <p>Create a new schema.</p>
+ <h1>deleteGroup</h1>
+ <p>Delete a group with specified id.</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Create a new schema.</p>
+ <p class="marked">Delete a group with specified id.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/schemas</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="delete"><code><span class="pln">/groups/{groupId}</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
- <li class="active"><a href="#examples-Schemas-createSchema-0-curl">Curl</a></li>
- <li class=""><a href="#examples-Schemas-createSchema-0-java">Java</a></li>
- <li class=""><a href="#examples-Schemas-createSchema-0-dart">Dart</a></li>
- <li class=""><a href="#examples-Schemas-createSchema-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-Schemas-createSchema-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-Schemas-createSchema-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-Schemas-createSchema-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-Schemas-createSchema-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-Schemas-createSchema-0-csharp">C#</a></li>
- <li class=""><a href="#examples-Schemas-createSchema-0-php">PHP</a></li>
- <li class=""><a href="#examples-Schemas-createSchema-0-perl">Perl</a></li>
- <li class=""><a href="#examples-Schemas-createSchema-0-python">Python</a></li>
- <li class=""><a href="#examples-Schemas-createSchema-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-TopologyGroups-deleteGroup-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-TopologyGroups-deleteGroup-0-java">Java</a></li>
+ <li class=""><a href="#examples-TopologyGroups-deleteGroup-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-TopologyGroups-deleteGroup-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-TopologyGroups-deleteGroup-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-TopologyGroups-deleteGroup-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-TopologyGroups-deleteGroup-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-TopologyGroups-deleteGroup-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-TopologyGroups-deleteGroup-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-TopologyGroups-deleteGroup-0-php">PHP</a></li>
+ <li class=""><a href="#examples-TopologyGroups-deleteGroup-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-TopologyGroups-deleteGroup-0-python">Python</a></li>
+ <li class=""><a href="#examples-TopologyGroups-deleteGroup-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-Schemas-createSchema-0-curl">
- <pre class="prettyprint"><code class="language-bsh">curl -X POST \
+ <div class="tab-pane active" id="examples-TopologyGroups-deleteGroup-0-curl">
+ <pre class="prettyprint"><code class="language-bsh">curl -X DELETE \
-H "Accept: application/problem+json" \
- -H "Content-Type: multipart/form-data" \
- "https://localhost/topology-inventory/v1alpha11/schemas"
+ "https://localhost/topology-inventory/v1alpha11/groups/{groupId}"
</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-createSchema-0-java">
+ <div class="tab-pane" id="examples-TopologyGroups-deleteGroup-0-java">
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
-import org.openapitools.client.api.SchemasApi;
+import org.openapitools.client.api.TopologyGroupsApi;
import java.io.File;
import java.util.*;
-public class SchemasApiExample {
+public class TopologyGroupsApiExample {
public static void main(String[] args) {
// Create an instance of the API class
- SchemasApi apiInstance = new SchemasApi();
+ TopologyGroupsApi apiInstance = new TopologyGroupsApi();
String accept = application/json; // String |
- String contentType = application/json; // String |
- File file = BINARY_DATA_HERE; // File | multipartFile
+ String groupId = groupId_example; // String |
try {
- apiInstance.createSchema(accept, contentType, file);
+ apiInstance.deleteGroup(accept, groupId);
} catch (ApiException e) {
- System.err.println("Exception when calling SchemasApi#createSchema");
+ System.err.println("Exception when calling TopologyGroupsApi#deleteGroup");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-createSchema-0-dart">
+ <div class="tab-pane" id="examples-TopologyGroups-deleteGroup-0-dart">
<pre class="prettyprint"><code class="language-dart">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
+final String groupId = new String(); // String |
try {
- final result = await api_instance.createSchema(accept, contentType, file);
+ final result = await api_instance.deleteGroup(accept, groupId);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->createSchema: $e\n');
+ print('Exception when calling DefaultApi->deleteGroup: $e\n');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-createSchema-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.SchemasApi;
+ <div class="tab-pane" id="examples-TopologyGroups-deleteGroup-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.TopologyGroupsApi;
-public class SchemasApiExample {
+public class TopologyGroupsApiExample {
public static void main(String[] args) {
- SchemasApi apiInstance = new SchemasApi();
+ TopologyGroupsApi apiInstance = new TopologyGroupsApi();
String accept = application/json; // String |
- String contentType = application/json; // String |
- File file = BINARY_DATA_HERE; // File | multipartFile
+ String groupId = groupId_example; // String |
try {
- apiInstance.createSchema(accept, contentType, file);
+ apiInstance.deleteGroup(accept, groupId);
} catch (ApiException e) {
- System.err.println("Exception when calling SchemasApi#createSchema");
+ System.err.println("Exception when calling TopologyGroupsApi#deleteGroup");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-Schemas-createSchema-0-groovy">
+ <div class="tab-pane" id="examples-TopologyGroups-deleteGroup-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-Schemas-createSchema-0-objc">
+ <div class="tab-pane" id="examples-TopologyGroups-deleteGroup-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// Create an instance of the API class
-SchemasApi *apiInstance = [[SchemasApi alloc] init];
+TopologyGroupsApi *apiInstance = [[TopologyGroupsApi 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)
+String *groupId = groupId_example; // (default to null)
-// Create a new schema.
-[apiInstance createSchemaWith:accept
- contentType:contentType
- file:file
+// Delete a group with specified id.
+[apiInstance deleteGroupWith:accept
+ groupId:groupId
completionHandler: ^(NSError* error) {
if (error) {
NSLog(@"Error: %@", error);
</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-createSchema-0-javascript">
- <pre class="prettyprint"><code class="language-js">var TopologyAndInventoryApi = require('topology_and_inventory_api');
+ <div class="tab-pane" id="examples-TopologyGroups-deleteGroup-0-javascript">
+ <pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
-var api = new TopologyAndInventoryApi.SchemasApi()
+var api = new TopologyExposureAndInventoryApi.TopologyGroupsApi()
var accept = application/json; // {String}
-var contentType = application/json; // {String}
-var file = BINARY_DATA_HERE; // {File} multipartFile
+var groupId = groupId_example; // {String}
var callback = function(error, data, response) {
if (error) {
console.log('API called successfully.');
}
};
-api.createSchema(accept, contentType, file, callback);
+api.deleteGroup(accept, groupId, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-Schemas-createSchema-0-angular">
+ <!--<div class="tab-pane" id="examples-TopologyGroups-deleteGroup-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-Schemas-createSchema-0-csharp">
+ <div class="tab-pane" id="examples-TopologyGroups-deleteGroup-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class createSchemaExample
+ public class deleteGroupExample
{
public void main()
{
// Create an instance of the API class
- var apiInstance = new SchemasApi();
+ var apiInstance = new TopologyGroupsApi();
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)
+ var groupId = groupId_example; // String | (default to null)
try {
- // Create a new schema.
- apiInstance.createSchema(accept, contentType, file);
+ // Delete a group with specified id.
+ apiInstance.deleteGroup(accept, groupId);
} catch (Exception e) {
- Debug.Print("Exception when calling SchemasApi.createSchema: " + e.Message );
+ Debug.Print("Exception when calling TopologyGroupsApi.deleteGroup: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-createSchema-0-php">
+ <div class="tab-pane" id="examples-TopologyGroups-deleteGroup-0-php">
<pre class="prettyprint"><code class="language-php"><?php
require_once(__DIR__ . '/vendor/autoload.php');
// Create an instance of the API class
-$api_instance = new OpenAPITools\Client\Api\SchemasApi();
+$api_instance = new OpenAPITools\Client\Api\TopologyGroupsApi();
$accept = application/json; // String |
-$contentType = application/json; // String |
-$file = BINARY_DATA_HERE; // File | multipartFile
+$groupId = groupId_example; // String |
try {
- $api_instance->createSchema($accept, $contentType, $file);
+ $api_instance->deleteGroup($accept, $groupId);
} catch (Exception $e) {
- echo 'Exception when calling SchemasApi->createSchema: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling TopologyGroupsApi->deleteGroup: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-createSchema-0-perl">
+ <div class="tab-pane" id="examples-TopologyGroups-deleteGroup-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::SchemasApi;
+use WWW::OPenAPIClient::TopologyGroupsApi;
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::SchemasApi->new();
+my $api_instance = WWW::OPenAPIClient::TopologyGroupsApi->new();
my $accept = application/json; # String |
-my $contentType = application/json; # String |
-my $file = BINARY_DATA_HERE; # File | multipartFile
+my $groupId = groupId_example; # String |
eval {
- $api_instance->createSchema(accept => $accept, contentType => $contentType, file => $file);
+ $api_instance->deleteGroup(accept => $accept, groupId => $groupId);
};
if ($@) {
- warn "Exception when calling SchemasApi->createSchema: $@\n";
+ warn "Exception when calling TopologyGroupsApi->deleteGroup: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-createSchema-0-python">
+ <div class="tab-pane" id="examples-TopologyGroups-deleteGroup-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import openapi_client
from pprint import pprint
# Create an instance of the API class
-api_instance = openapi_client.SchemasApi()
+api_instance = openapi_client.TopologyGroupsApi()
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)
+groupId = groupId_example # String | (default to null)
try:
- # Create a new schema.
- api_instance.create_schema(accept, contentType, file)
+ # Delete a group with specified id.
+ api_instance.delete_group(accept, groupId)
except ApiException as e:
- print("Exception when calling SchemasApi->createSchema: %s\n" % e)</code></pre>
+ print("Exception when calling TopologyGroupsApi->deleteGroup: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-createSchema-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate SchemasApi;
+ <div class="tab-pane" id="examples-TopologyGroups-deleteGroup-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate TopologyGroupsApi;
pub fn main() {
let accept = application/json; // String
- let contentType = application/json; // String
- let file = BINARY_DATA_HERE; // File
+ let groupId = groupId_example; // String
- let mut context = SchemasApi::Context::default();
- let result = client.createSchema(accept, contentType, file, &context).wait();
+ let mut context = TopologyGroupsApi::Context::default();
+ let result = client.deleteGroup(accept, groupId, &context).wait();
println!("{:?}", result);
}
</div>
</div>
- <h2>Scopes</h2>
- <table>
-
- </table>
-
- <h2>Parameters</h2>
-
-
- <div class="methodsubtabletitle">Header parameters</div>
- <table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">Accept*</td>
-<td>
-
-
- <div id="d2e199_createSchema_accept">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- String
- </span>
-
- </div>
- <div class="inner required">
- Required
- </div>
- </div>
- </div>
-</td>
-</tr>
-
- <tr><td style="width:150px;">Content-Type*</td>
+ <h2>Scopes</h2>
+ <table>
+
+ </table>
+
+ <h2>Parameters</h2>
+
+ <div class="methodsubtabletitle">Path parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">groupId*</td>
<td>
- <div id="d2e199_createSchema_contentType">
+ <div id="d2e199_deleteGroup_groupId">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
</table>
-
- <div class="methodsubtabletitle">Form parameters</div>
+ <div class="methodsubtabletitle">Header parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
- <tr><td style="width:150px;">file*</td>
+ <tr><td style="width:150px;">Accept*</td>
<td>
- <div id="d2e199_createSchema_file">
+ <div id="d2e199_deleteGroup_accept">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
- File
+ String
</span>
- <span class="format">
- (binary)
- </span>
- <div class="inner description marked">
-multipartFile
- </div>
</div>
<div class="inner required">
Required
</table>
+
+
<h2>Responses</h2>
- <h3 id="examples-Schemas-createSchema-title-201"></h3>
- <p id="examples-Schemas-createSchema-description-201" class="marked"></p>
+ <h3 id="examples-TopologyGroups-deleteGroup-title-204"></h3>
+ <p id="examples-TopologyGroups-deleteGroup-description-204" class="marked"></p>
<script>
- var responseSchemas201_description = `Created without response body`;
- var responseSchemas201_description_break = responseSchemas201_description.indexOf('\n');
- if (responseSchemas201_description_break == -1) {
- $("#examples-Schemas-createSchema-title-201").text("Status: 201 - " + responseSchemas201_description);
+ var responseTopologyGroups204_description = `No Content`;
+ var responseTopologyGroups204_description_break = responseTopologyGroups204_description.indexOf('\n');
+ if (responseTopologyGroups204_description_break == -1) {
+ $("#examples-TopologyGroups-deleteGroup-title-204").text("Status: 204 - " + responseTopologyGroups204_description);
} else {
- $("#examples-Schemas-createSchema-title-201").text("Status: 201 - " + responseSchemas201_description.substring(0, responseSchemas201_description_break));
- $("#examples-Schemas-createSchema-description-201").html(responseSchemas201_description.substring(responseSchemas201_description_break));
+ $("#examples-TopologyGroups-deleteGroup-title-204").text("Status: 204 - " + responseTopologyGroups204_description.substring(0, responseTopologyGroups204_description_break));
+ $("#examples-TopologyGroups-deleteGroup-description-204").html(responseTopologyGroups204_description.substring(responseTopologyGroups204_description_break));
}
</script>
- <ul id="responses-detail-Schemas-createSchema-201" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-TopologyGroups-deleteGroup-204" class="nav nav-tabs nav-tabs-examples" >
</ul>
- <div class="tab-content" id="responses-Schemas-createSchema-201-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-createSchema-201-schema">
- <div id="responses-Schemas-createSchema-schema-201" class="exampleStyle">
+ <div class="tab-content" id="responses-TopologyGroups-deleteGroup-204-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-TopologyGroups-deleteGroup-204-schema">
+ <div id="responses-TopologyGroups-deleteGroup-schema-204" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Created without response body"
+ "description" : "No Content",
+ "content" : { }
};
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-createSchema-201-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-createSchema-schema-201');
+ $('#responses-TopologyGroups-deleteGroup-204-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-TopologyGroups-deleteGroup-schema-204');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-createSchema-201-schema-data' type='hidden' value=''></input>
+ <input id='responses-TopologyGroups-deleteGroup-204-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-createSchema-title-400"></h3>
- <p id="examples-Schemas-createSchema-description-400" class="marked"></p>
+ <h3 id="examples-TopologyGroups-deleteGroup-title-400"></h3>
+ <p id="examples-TopologyGroups-deleteGroup-description-400" class="marked"></p>
<script>
- var responseSchemas400_description = `Bad Request`;
- var responseSchemas400_description_break = responseSchemas400_description.indexOf('\n');
- if (responseSchemas400_description_break == -1) {
- $("#examples-Schemas-createSchema-title-400").text("Status: 400 - " + responseSchemas400_description);
+ var responseTopologyGroups400_description = `Bad Request`;
+ var responseTopologyGroups400_description_break = responseTopologyGroups400_description.indexOf('\n');
+ if (responseTopologyGroups400_description_break == -1) {
+ $("#examples-TopologyGroups-deleteGroup-title-400").text("Status: 400 - " + responseTopologyGroups400_description);
} else {
- $("#examples-Schemas-createSchema-title-400").text("Status: 400 - " + responseSchemas400_description.substring(0, responseSchemas400_description_break));
- $("#examples-Schemas-createSchema-description-400").html(responseSchemas400_description.substring(responseSchemas400_description_break));
+ $("#examples-TopologyGroups-deleteGroup-title-400").text("Status: 400 - " + responseTopologyGroups400_description.substring(0, responseTopologyGroups400_description_break));
+ $("#examples-TopologyGroups-deleteGroup-description-400").html(responseTopologyGroups400_description.substring(responseTopologyGroups400_description_break));
}
</script>
- <ul id="responses-detail-Schemas-createSchema-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-TopologyGroups-deleteGroup-400" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-createSchema-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-TopologyGroups-deleteGroup-400-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-createSchema-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-createSchema-400-schema">
- <div id="responses-Schemas-createSchema-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-TopologyGroups-deleteGroup-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-TopologyGroups-deleteGroup-400-schema">
+ <div id="responses-TopologyGroups-deleteGroup-schema-400" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-createSchema-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-createSchema-schema-400');
+ $('#responses-TopologyGroups-deleteGroup-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-TopologyGroups-deleteGroup-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-createSchema-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-TopologyGroups-deleteGroup-400-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-createSchema-title-401"></h3>
- <p id="examples-Schemas-createSchema-description-401" class="marked"></p>
+ <h3 id="examples-TopologyGroups-deleteGroup-title-401"></h3>
+ <p id="examples-TopologyGroups-deleteGroup-description-401" class="marked"></p>
<script>
- var responseSchemas401_description = `Unauthorized`;
- var responseSchemas401_description_break = responseSchemas401_description.indexOf('\n');
- if (responseSchemas401_description_break == -1) {
- $("#examples-Schemas-createSchema-title-401").text("Status: 401 - " + responseSchemas401_description);
+ var responseTopologyGroups401_description = `Unauthorized`;
+ var responseTopologyGroups401_description_break = responseTopologyGroups401_description.indexOf('\n');
+ if (responseTopologyGroups401_description_break == -1) {
+ $("#examples-TopologyGroups-deleteGroup-title-401").text("Status: 401 - " + responseTopologyGroups401_description);
} else {
- $("#examples-Schemas-createSchema-title-401").text("Status: 401 - " + responseSchemas401_description.substring(0, responseSchemas401_description_break));
- $("#examples-Schemas-createSchema-description-401").html(responseSchemas401_description.substring(responseSchemas401_description_break));
+ $("#examples-TopologyGroups-deleteGroup-title-401").text("Status: 401 - " + responseTopologyGroups401_description.substring(0, responseTopologyGroups401_description_break));
+ $("#examples-TopologyGroups-deleteGroup-description-401").html(responseTopologyGroups401_description.substring(responseTopologyGroups401_description_break));
}
</script>
- <ul id="responses-detail-Schemas-createSchema-401" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-TopologyGroups-deleteGroup-401" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-createSchema-401-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-TopologyGroups-deleteGroup-401-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-createSchema-401-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-createSchema-401-schema">
- <div id="responses-Schemas-createSchema-schema-401" class="exampleStyle">
+ <div class="tab-content" id="responses-TopologyGroups-deleteGroup-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-TopologyGroups-deleteGroup-401-schema">
+ <div id="responses-TopologyGroups-deleteGroup-schema-401" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-createSchema-401-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-createSchema-schema-401');
+ $('#responses-TopologyGroups-deleteGroup-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-TopologyGroups-deleteGroup-schema-401');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-createSchema-401-schema-data' type='hidden' value=''></input>
+ <input id='responses-TopologyGroups-deleteGroup-401-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-createSchema-title-403"></h3>
- <p id="examples-Schemas-createSchema-description-403" class="marked"></p>
+ <h3 id="examples-TopologyGroups-deleteGroup-title-403"></h3>
+ <p id="examples-TopologyGroups-deleteGroup-description-403" class="marked"></p>
<script>
- var responseSchemas403_description = `Forbidden`;
- var responseSchemas403_description_break = responseSchemas403_description.indexOf('\n');
- if (responseSchemas403_description_break == -1) {
- $("#examples-Schemas-createSchema-title-403").text("Status: 403 - " + responseSchemas403_description);
+ var responseTopologyGroups403_description = `Forbidden`;
+ var responseTopologyGroups403_description_break = responseTopologyGroups403_description.indexOf('\n');
+ if (responseTopologyGroups403_description_break == -1) {
+ $("#examples-TopologyGroups-deleteGroup-title-403").text("Status: 403 - " + responseTopologyGroups403_description);
} else {
- $("#examples-Schemas-createSchema-title-403").text("Status: 403 - " + responseSchemas403_description.substring(0, responseSchemas403_description_break));
- $("#examples-Schemas-createSchema-description-403").html(responseSchemas403_description.substring(responseSchemas403_description_break));
+ $("#examples-TopologyGroups-deleteGroup-title-403").text("Status: 403 - " + responseTopologyGroups403_description.substring(0, responseTopologyGroups403_description_break));
+ $("#examples-TopologyGroups-deleteGroup-description-403").html(responseTopologyGroups403_description.substring(responseTopologyGroups403_description_break));
}
</script>
- <ul id="responses-detail-Schemas-createSchema-403" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-TopologyGroups-deleteGroup-403" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-createSchema-403-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-TopologyGroups-deleteGroup-403-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-createSchema-403-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-createSchema-403-schema">
- <div id="responses-Schemas-createSchema-schema-403" class="exampleStyle">
+ <div class="tab-content" id="responses-TopologyGroups-deleteGroup-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-TopologyGroups-deleteGroup-403-schema">
+ <div id="responses-TopologyGroups-deleteGroup-schema-403" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-createSchema-403-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-createSchema-schema-403');
+ $('#responses-TopologyGroups-deleteGroup-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-TopologyGroups-deleteGroup-schema-403');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-createSchema-403-schema-data' type='hidden' value=''></input>
+ <input id='responses-TopologyGroups-deleteGroup-403-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-createSchema-title-409"></h3>
- <p id="examples-Schemas-createSchema-description-409" class="marked"></p>
+ <h3 id="examples-TopologyGroups-deleteGroup-title-404"></h3>
+ <p id="examples-TopologyGroups-deleteGroup-description-404" class="marked"></p>
<script>
- var responseSchemas409_description = `Conflict`;
- var responseSchemas409_description_break = responseSchemas409_description.indexOf('\n');
- if (responseSchemas409_description_break == -1) {
- $("#examples-Schemas-createSchema-title-409").text("Status: 409 - " + responseSchemas409_description);
+ var responseTopologyGroups404_description = `Not Found`;
+ var responseTopologyGroups404_description_break = responseTopologyGroups404_description.indexOf('\n');
+ if (responseTopologyGroups404_description_break == -1) {
+ $("#examples-TopologyGroups-deleteGroup-title-404").text("Status: 404 - " + responseTopologyGroups404_description);
} else {
- $("#examples-Schemas-createSchema-title-409").text("Status: 409 - " + responseSchemas409_description.substring(0, responseSchemas409_description_break));
- $("#examples-Schemas-createSchema-description-409").html(responseSchemas409_description.substring(responseSchemas409_description_break));
+ $("#examples-TopologyGroups-deleteGroup-title-404").text("Status: 404 - " + responseTopologyGroups404_description.substring(0, responseTopologyGroups404_description_break));
+ $("#examples-TopologyGroups-deleteGroup-description-404").html(responseTopologyGroups404_description.substring(responseTopologyGroups404_description_break));
}
</script>
- <ul id="responses-detail-Schemas-createSchema-409" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-TopologyGroups-deleteGroup-404" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-createSchema-409-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-TopologyGroups-deleteGroup-404-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-createSchema-409-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-createSchema-409-schema">
- <div id="responses-Schemas-createSchema-schema-409" class="exampleStyle">
+ <div class="tab-content" id="responses-TopologyGroups-deleteGroup-404-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-TopologyGroups-deleteGroup-404-schema">
+ <div id="responses-TopologyGroups-deleteGroup-schema-404" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "Conflict",
+ "description" : "Not Found",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
- "status" : "409'",
- "title" : "Conflicting request",
- "details" : "The request cannot be processed as the resource is in use."
+ "status" : "404",
+ "title" : "Resource Not Found",
+ "details" : "The requested resource is not found"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-createSchema-409-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-createSchema-schema-409');
+ $('#responses-TopologyGroups-deleteGroup-404-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-TopologyGroups-deleteGroup-schema-404');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-createSchema-409-schema-data' type='hidden' value=''></input>
+ <input id='responses-TopologyGroups-deleteGroup-404-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-createSchema-title-500"></h3>
- <p id="examples-Schemas-createSchema-description-500" class="marked"></p>
+ <h3 id="examples-TopologyGroups-deleteGroup-title-500"></h3>
+ <p id="examples-TopologyGroups-deleteGroup-description-500" class="marked"></p>
<script>
- var responseSchemas500_description = `Internal Server Error`;
- var responseSchemas500_description_break = responseSchemas500_description.indexOf('\n');
- if (responseSchemas500_description_break == -1) {
- $("#examples-Schemas-createSchema-title-500").text("Status: 500 - " + responseSchemas500_description);
+ var responseTopologyGroups500_description = `Internal Server Error`;
+ var responseTopologyGroups500_description_break = responseTopologyGroups500_description.indexOf('\n');
+ if (responseTopologyGroups500_description_break == -1) {
+ $("#examples-TopologyGroups-deleteGroup-title-500").text("Status: 500 - " + responseTopologyGroups500_description);
} else {
- $("#examples-Schemas-createSchema-title-500").text("Status: 500 - " + responseSchemas500_description.substring(0, responseSchemas500_description_break));
- $("#examples-Schemas-createSchema-description-500").html(responseSchemas500_description.substring(responseSchemas500_description_break));
+ $("#examples-TopologyGroups-deleteGroup-title-500").text("Status: 500 - " + responseTopologyGroups500_description.substring(0, responseTopologyGroups500_description_break));
+ $("#examples-TopologyGroups-deleteGroup-description-500").html(responseTopologyGroups500_description.substring(responseTopologyGroups500_description_break));
}
</script>
- <ul id="responses-detail-Schemas-createSchema-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-TopologyGroups-deleteGroup-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-createSchema-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-TopologyGroups-deleteGroup-500-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-createSchema-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-createSchema-500-schema">
- <div id="responses-Schemas-createSchema-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-TopologyGroups-deleteGroup-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-TopologyGroups-deleteGroup-500-schema">
+ <div id="responses-TopologyGroups-deleteGroup-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-createSchema-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-createSchema-schema-500');
+ $('#responses-TopologyGroups-deleteGroup-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-TopologyGroups-deleteGroup-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-createSchema-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-TopologyGroups-deleteGroup-500-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- <div id="api-Schemas-deleteSchema">
- <article id="api-Schemas-deleteSchema-0" data-group="User" data-name="deleteSchema" data-version="0">
+ <div id="api-TopologyGroups-getAllGroups">
+ <article id="api-TopologyGroups-getAllGroups-0" data-group="User" data-name="getAllGroups" data-version="0">
<div class="pull-left">
- <h1>deleteSchema</h1>
- <p>Delete a schema.</p>
+ <h1>getAllGroups</h1>
+ <p>Get all groups.</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Delete a schema.</p>
+ <p class="marked">Get all groups.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="delete"><code><span class="pln">/schemas/{schemaName}</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/groups</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
- <li class="active"><a href="#examples-Schemas-deleteSchema-0-curl">Curl</a></li>
- <li class=""><a href="#examples-Schemas-deleteSchema-0-java">Java</a></li>
- <li class=""><a href="#examples-Schemas-deleteSchema-0-dart">Dart</a></li>
- <li class=""><a href="#examples-Schemas-deleteSchema-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-Schemas-deleteSchema-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-Schemas-deleteSchema-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-Schemas-deleteSchema-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-Schemas-deleteSchema-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-Schemas-deleteSchema-0-csharp">C#</a></li>
- <li class=""><a href="#examples-Schemas-deleteSchema-0-php">PHP</a></li>
- <li class=""><a href="#examples-Schemas-deleteSchema-0-perl">Perl</a></li>
- <li class=""><a href="#examples-Schemas-deleteSchema-0-python">Python</a></li>
- <li class=""><a href="#examples-Schemas-deleteSchema-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-TopologyGroups-getAllGroups-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-TopologyGroups-getAllGroups-0-java">Java</a></li>
+ <li class=""><a href="#examples-TopologyGroups-getAllGroups-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-TopologyGroups-getAllGroups-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-TopologyGroups-getAllGroups-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-TopologyGroups-getAllGroups-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-TopologyGroups-getAllGroups-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-TopologyGroups-getAllGroups-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-TopologyGroups-getAllGroups-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-TopologyGroups-getAllGroups-0-php">PHP</a></li>
+ <li class=""><a href="#examples-TopologyGroups-getAllGroups-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-TopologyGroups-getAllGroups-0-python">Python</a></li>
+ <li class=""><a href="#examples-TopologyGroups-getAllGroups-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-Schemas-deleteSchema-0-curl">
- <pre class="prettyprint"><code class="language-bsh">curl -X DELETE \
- -H "Accept: application/problem+json" \
- "https://localhost/topology-inventory/v1alpha11/schemas/{schemaName}"
+ <div class="tab-pane active" id="examples-TopologyGroups-getAllGroups-0-curl">
+ <pre class="prettyprint"><code class="language-bsh">curl -X GET \
+ -H "Accept: application/json,application/problem+json" \
+ "https://localhost/topology-inventory/v1alpha11/groups?offset=56&limit=56"
</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-deleteSchema-0-java">
+ <div class="tab-pane" id="examples-TopologyGroups-getAllGroups-0-java">
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
-import org.openapitools.client.api.SchemasApi;
+import org.openapitools.client.api.TopologyGroupsApi;
import java.io.File;
import java.util.*;
-public class SchemasApiExample {
+public class TopologyGroupsApiExample {
public static void main(String[] args) {
// Create an instance of the API class
- SchemasApi apiInstance = new SchemasApi();
+ TopologyGroupsApi apiInstance = new TopologyGroupsApi();
String accept = application/json; // String |
- String schemaName = schemaName_example; // String |
+ Integer offset = 56; // Integer | Pagination offset.
+ Integer limit = 56; // Integer | Result limiter.
try {
- apiInstance.deleteSchema(accept, schemaName);
+ Groups result = apiInstance.getAllGroups(accept, offset, limit);
+ System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling SchemasApi#deleteSchema");
+ System.err.println("Exception when calling TopologyGroupsApi#getAllGroups");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-deleteSchema-0-dart">
+ <div class="tab-pane" id="examples-TopologyGroups-getAllGroups-0-dart">
<pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
final api_instance = DefaultApi();
final String accept = new String(); // String |
-final String schemaName = 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.deleteSchema(accept, schemaName);
+ final result = await api_instance.getAllGroups(accept, offset, limit);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->deleteSchema: $e\n');
+ print('Exception when calling DefaultApi->getAllGroups: $e\n');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-deleteSchema-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.SchemasApi;
+ <div class="tab-pane" id="examples-TopologyGroups-getAllGroups-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.TopologyGroupsApi;
-public class SchemasApiExample {
+public class TopologyGroupsApiExample {
public static void main(String[] args) {
- SchemasApi apiInstance = new SchemasApi();
+ TopologyGroupsApi apiInstance = new TopologyGroupsApi();
String accept = application/json; // String |
- String schemaName = schemaName_example; // String |
+ Integer offset = 56; // Integer | Pagination offset.
+ Integer limit = 56; // Integer | Result limiter.
try {
- apiInstance.deleteSchema(accept, schemaName);
+ Groups result = apiInstance.getAllGroups(accept, offset, limit);
+ System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling SchemasApi#deleteSchema");
+ System.err.println("Exception when calling TopologyGroupsApi#getAllGroups");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-Schemas-deleteSchema-0-groovy">
+ <div class="tab-pane" id="examples-TopologyGroups-getAllGroups-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-Schemas-deleteSchema-0-objc">
+ <div class="tab-pane" id="examples-TopologyGroups-getAllGroups-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// Create an instance of the API class
-SchemasApi *apiInstance = [[SchemasApi alloc] init];
+TopologyGroupsApi *apiInstance = [[TopologyGroupsApi alloc] init];
String *accept = application/json; // (default to application/json)
-String *schemaName = schemaName_example; // (default to o-ran-smo-teiv-ran)
+Integer *offset = 56; // Pagination offset. (optional) (default to 0)
+Integer *limit = 56; // Result limiter. (optional) (default to 500)
-// Delete a schema.
-[apiInstance deleteSchemaWith:accept
- schemaName:schemaName
- completionHandler: ^(NSError* error) {
+// Get all groups.
+[apiInstance getAllGroupsWith:accept
+ offset:offset
+ limit:limit
+ completionHandler: ^(Groups output, NSError* error) {
+ if (output) {
+ NSLog(@"%@", output);
+ }
if (error) {
NSLog(@"Error: %@", error);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-deleteSchema-0-javascript">
- <pre class="prettyprint"><code class="language-js">var TopologyAndInventoryApi = require('topology_and_inventory_api');
+ <div class="tab-pane" id="examples-TopologyGroups-getAllGroups-0-javascript">
+ <pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
-var api = new TopologyAndInventoryApi.SchemasApi()
+var api = new TopologyExposureAndInventoryApi.TopologyGroupsApi()
var accept = application/json; // {String}
-var schemaName = schemaName_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.deleteSchema(accept, schemaName, callback);
+api.getAllGroups(accept, opts, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-Schemas-deleteSchema-0-angular">
+ <!--<div class="tab-pane" id="examples-TopologyGroups-getAllGroups-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-Schemas-deleteSchema-0-csharp">
+ <div class="tab-pane" id="examples-TopologyGroups-getAllGroups-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class deleteSchemaExample
+ public class getAllGroupsExample
{
public void main()
{
// Create an instance of the API class
- var apiInstance = new SchemasApi();
+ var apiInstance = new TopologyGroupsApi();
var accept = application/json; // String | (default to application/json)
- var schemaName = schemaName_example; // String | (default to o-ran-smo-teiv-ran)
+ var offset = 56; // Integer | Pagination offset. (optional) (default to 0)
+ var limit = 56; // Integer | Result limiter. (optional) (default to 500)
try {
- // Delete a schema.
- apiInstance.deleteSchema(accept, schemaName);
+ // Get all groups.
+ Groups result = apiInstance.getAllGroups(accept, offset, limit);
+ Debug.WriteLine(result);
} catch (Exception e) {
- Debug.Print("Exception when calling SchemasApi.deleteSchema: " + e.Message );
+ Debug.Print("Exception when calling TopologyGroupsApi.getAllGroups: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-deleteSchema-0-php">
+ <div class="tab-pane" id="examples-TopologyGroups-getAllGroups-0-php">
<pre class="prettyprint"><code class="language-php"><?php
require_once(__DIR__ . '/vendor/autoload.php');
// Create an instance of the API class
-$api_instance = new OpenAPITools\Client\Api\SchemasApi();
+$api_instance = new OpenAPITools\Client\Api\TopologyGroupsApi();
$accept = application/json; // String |
-$schemaName = schemaName_example; // String |
+$offset = 56; // Integer | Pagination offset.
+$limit = 56; // Integer | Result limiter.
try {
- $api_instance->deleteSchema($accept, $schemaName);
+ $result = $api_instance->getAllGroups($accept, $offset, $limit);
+ print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling SchemasApi->deleteSchema: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling TopologyGroupsApi->getAllGroups: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-deleteSchema-0-perl">
+ <div class="tab-pane" id="examples-TopologyGroups-getAllGroups-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::SchemasApi;
+use WWW::OPenAPIClient::TopologyGroupsApi;
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::SchemasApi->new();
+my $api_instance = WWW::OPenAPIClient::TopologyGroupsApi->new();
my $accept = application/json; # String |
-my $schemaName = schemaName_example; # String |
+my $offset = 56; # Integer | Pagination offset.
+my $limit = 56; # Integer | Result limiter.
eval {
- $api_instance->deleteSchema(accept => $accept, schemaName => $schemaName);
+ my $result = $api_instance->getAllGroups(accept => $accept, offset => $offset, limit => $limit);
+ print Dumper($result);
};
if ($@) {
- warn "Exception when calling SchemasApi->deleteSchema: $@\n";
+ warn "Exception when calling TopologyGroupsApi->getAllGroups: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-deleteSchema-0-python">
+ <div class="tab-pane" id="examples-TopologyGroups-getAllGroups-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import openapi_client
from pprint import pprint
# Create an instance of the API class
-api_instance = openapi_client.SchemasApi()
+api_instance = openapi_client.TopologyGroupsApi()
accept = application/json # String | (default to application/json)
-schemaName = schemaName_example # String | (default to o-ran-smo-teiv-ran)
+offset = 56 # Integer | Pagination offset. (optional) (default to 0)
+limit = 56 # Integer | Result limiter. (optional) (default to 500)
try:
- # Delete a schema.
- api_instance.delete_schema(accept, schemaName)
+ # Get all groups.
+ api_response = api_instance.get_all_groups(accept, offset=offset, limit=limit)
+ pprint(api_response)
except ApiException as e:
- print("Exception when calling SchemasApi->deleteSchema: %s\n" % e)</code></pre>
+ print("Exception when calling TopologyGroupsApi->getAllGroups: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-deleteSchema-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate SchemasApi;
+ <div class="tab-pane" id="examples-TopologyGroups-getAllGroups-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate TopologyGroupsApi;
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();
+ let offset = 56; // Integer
+ let limit = 56; // Integer
+
+ let mut context = TopologyGroupsApi::Context::default();
+ let result = client.getAllGroups(accept, offset, limit, &context).wait();
println!("{:?}", result);
}
<h2>Parameters</h2>
- <div class="methodsubtabletitle">Path parameters</div>
+
+ <div class="methodsubtabletitle">Header parameters</div>
<table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">schemaName*</td>
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">Accept*</td>
<td>
- <div id="d2e199_deleteSchema_schemaName">
+ <div id="d2e199_getAllGroups_accept">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
</table>
- <div class="methodsubtabletitle">Header parameters</div>
+
+
+ <div class="methodsubtabletitle">Query parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
- <tr><td style="width:150px;">Accept*</td>
+ <tr><td style="width:150px;">offset</td>
<td>
- <div id="d2e199_deleteSchema_accept">
+ <div id="d2e199_getAllGroups_offset">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
- String
+ Integer
</span>
+ <div class="inner description marked">
+Pagination offset.
+ </div>
</div>
- <div class="inner required">
- Required
- </div>
</div>
</div>
</td>
</tr>
- </table>
+ <tr><td style="width:150px;">limit</td>
+<td>
+
+ <div id="d2e199_getAllGroups_limit">
+ <div class="json-schema-view">
+ <div class="primitive">
+ <span class="type">
+ Integer
+ </span>
+ <div class="inner description marked">
+Result limiter.
+ </div>
+ </div>
+ </div>
+ </div>
+</td>
+</tr>
+ </table>
<h2>Responses</h2>
- <h3 id="examples-Schemas-deleteSchema-title-204"></h3>
- <p id="examples-Schemas-deleteSchema-description-204" class="marked"></p>
+ <h3 id="examples-TopologyGroups-getAllGroups-title-200"></h3>
+ <p id="examples-TopologyGroups-getAllGroups-description-200" class="marked"></p>
<script>
- var responseSchemas204_description = `No Content`;
- var responseSchemas204_description_break = responseSchemas204_description.indexOf('\n');
- if (responseSchemas204_description_break == -1) {
- $("#examples-Schemas-deleteSchema-title-204").text("Status: 204 - " + responseSchemas204_description);
+ var responseTopologyGroups200_description = `OK`;
+ var responseTopologyGroups200_description_break = responseTopologyGroups200_description.indexOf('\n');
+ if (responseTopologyGroups200_description_break == -1) {
+ $("#examples-TopologyGroups-getAllGroups-title-200").text("Status: 200 - " + responseTopologyGroups200_description);
} else {
- $("#examples-Schemas-deleteSchema-title-204").text("Status: 204 - " + responseSchemas204_description.substring(0, responseSchemas204_description_break));
- $("#examples-Schemas-deleteSchema-description-204").html(responseSchemas204_description.substring(responseSchemas204_description_break));
+ $("#examples-TopologyGroups-getAllGroups-title-200").text("Status: 200 - " + responseTopologyGroups200_description.substring(0, responseTopologyGroups200_description_break));
+ $("#examples-TopologyGroups-getAllGroups-description-200").html(responseTopologyGroups200_description.substring(responseTopologyGroups200_description_break));
}
</script>
- <ul id="responses-detail-Schemas-deleteSchema-204" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-TopologyGroups-getAllGroups-200" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-TopologyGroups-getAllGroups-200-schema">Schema</a>
+ </li>
+
+
</ul>
- <div class="tab-content" id="responses-Schemas-deleteSchema-204-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-deleteSchema-204-schema">
- <div id="responses-Schemas-deleteSchema-schema-204" class="exampleStyle">
+ <div class="tab-content" id="responses-TopologyGroups-getAllGroups-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-TopologyGroups-getAllGroups-200-schema">
+ <div id="responses-TopologyGroups-getAllGroups-schema-200" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "OK",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/Groups"
+ },
+ "examples" : {
+ "groups" : {
+ "$ref" : "#/components/examples/GroupsResponseExample"
+ }
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-TopologyGroups-getAllGroups-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-TopologyGroups-getAllGroups-schema-200');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-TopologyGroups-getAllGroups-200-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-TopologyGroups-getAllGroups-title-204"></h3>
+ <p id="examples-TopologyGroups-getAllGroups-description-204" class="marked"></p>
+ <script>
+ var responseTopologyGroups204_description = `No Content`;
+ var responseTopologyGroups204_description_break = responseTopologyGroups204_description.indexOf('\n');
+ if (responseTopologyGroups204_description_break == -1) {
+ $("#examples-TopologyGroups-getAllGroups-title-204").text("Status: 204 - " + responseTopologyGroups204_description);
+ } else {
+ $("#examples-TopologyGroups-getAllGroups-title-204").text("Status: 204 - " + responseTopologyGroups204_description.substring(0, responseTopologyGroups204_description_break));
+ $("#examples-TopologyGroups-getAllGroups-description-204").html(responseTopologyGroups204_description.substring(responseTopologyGroups204_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-TopologyGroups-getAllGroups-204" class="nav nav-tabs nav-tabs-examples" >
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-TopologyGroups-getAllGroups-204-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-TopologyGroups-getAllGroups-204-schema">
+ <div id="responses-TopologyGroups-getAllGroups-schema-204" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-deleteSchema-204-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-deleteSchema-schema-204');
+ $('#responses-TopologyGroups-getAllGroups-204-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-TopologyGroups-getAllGroups-schema-204');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-deleteSchema-204-schema-data' type='hidden' value=''></input>
+ <input id='responses-TopologyGroups-getAllGroups-204-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-deleteSchema-title-400"></h3>
- <p id="examples-Schemas-deleteSchema-description-400" class="marked"></p>
+ <h3 id="examples-TopologyGroups-getAllGroups-title-400"></h3>
+ <p id="examples-TopologyGroups-getAllGroups-description-400" class="marked"></p>
<script>
- var responseSchemas400_description = `Bad Request`;
- var responseSchemas400_description_break = responseSchemas400_description.indexOf('\n');
- if (responseSchemas400_description_break == -1) {
- $("#examples-Schemas-deleteSchema-title-400").text("Status: 400 - " + responseSchemas400_description);
+ var responseTopologyGroups400_description = `Bad Request`;
+ var responseTopologyGroups400_description_break = responseTopologyGroups400_description.indexOf('\n');
+ if (responseTopologyGroups400_description_break == -1) {
+ $("#examples-TopologyGroups-getAllGroups-title-400").text("Status: 400 - " + responseTopologyGroups400_description);
} else {
- $("#examples-Schemas-deleteSchema-title-400").text("Status: 400 - " + responseSchemas400_description.substring(0, responseSchemas400_description_break));
- $("#examples-Schemas-deleteSchema-description-400").html(responseSchemas400_description.substring(responseSchemas400_description_break));
+ $("#examples-TopologyGroups-getAllGroups-title-400").text("Status: 400 - " + responseTopologyGroups400_description.substring(0, responseTopologyGroups400_description_break));
+ $("#examples-TopologyGroups-getAllGroups-description-400").html(responseTopologyGroups400_description.substring(responseTopologyGroups400_description_break));
}
</script>
- <ul id="responses-detail-Schemas-deleteSchema-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-TopologyGroups-getAllGroups-400" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-deleteSchema-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-TopologyGroups-getAllGroups-400-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-deleteSchema-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-deleteSchema-400-schema">
- <div id="responses-Schemas-deleteSchema-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-TopologyGroups-getAllGroups-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-TopologyGroups-getAllGroups-400-schema">
+ <div id="responses-TopologyGroups-getAllGroups-schema-400" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-deleteSchema-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-deleteSchema-schema-400');
+ $('#responses-TopologyGroups-getAllGroups-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-TopologyGroups-getAllGroups-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-deleteSchema-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-TopologyGroups-getAllGroups-400-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-deleteSchema-title-401"></h3>
- <p id="examples-Schemas-deleteSchema-description-401" class="marked"></p>
+ <h3 id="examples-TopologyGroups-getAllGroups-title-401"></h3>
+ <p id="examples-TopologyGroups-getAllGroups-description-401" class="marked"></p>
<script>
- var responseSchemas401_description = `Unauthorized`;
- var responseSchemas401_description_break = responseSchemas401_description.indexOf('\n');
- if (responseSchemas401_description_break == -1) {
- $("#examples-Schemas-deleteSchema-title-401").text("Status: 401 - " + responseSchemas401_description);
+ var responseTopologyGroups401_description = `Unauthorized`;
+ var responseTopologyGroups401_description_break = responseTopologyGroups401_description.indexOf('\n');
+ if (responseTopologyGroups401_description_break == -1) {
+ $("#examples-TopologyGroups-getAllGroups-title-401").text("Status: 401 - " + responseTopologyGroups401_description);
} else {
- $("#examples-Schemas-deleteSchema-title-401").text("Status: 401 - " + responseSchemas401_description.substring(0, responseSchemas401_description_break));
- $("#examples-Schemas-deleteSchema-description-401").html(responseSchemas401_description.substring(responseSchemas401_description_break));
+ $("#examples-TopologyGroups-getAllGroups-title-401").text("Status: 401 - " + responseTopologyGroups401_description.substring(0, responseTopologyGroups401_description_break));
+ $("#examples-TopologyGroups-getAllGroups-description-401").html(responseTopologyGroups401_description.substring(responseTopologyGroups401_description_break));
}
</script>
- <ul id="responses-detail-Schemas-deleteSchema-401" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-TopologyGroups-getAllGroups-401" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-deleteSchema-401-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-TopologyGroups-getAllGroups-401-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-deleteSchema-401-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-deleteSchema-401-schema">
- <div id="responses-Schemas-deleteSchema-schema-401" class="exampleStyle">
+ <div class="tab-content" id="responses-TopologyGroups-getAllGroups-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-TopologyGroups-getAllGroups-401-schema">
+ <div id="responses-TopologyGroups-getAllGroups-schema-401" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-deleteSchema-401-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-deleteSchema-schema-401');
+ $('#responses-TopologyGroups-getAllGroups-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-TopologyGroups-getAllGroups-schema-401');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-deleteSchema-401-schema-data' type='hidden' value=''></input>
+ <input id='responses-TopologyGroups-getAllGroups-401-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-deleteSchema-title-403"></h3>
- <p id="examples-Schemas-deleteSchema-description-403" class="marked"></p>
+ <h3 id="examples-TopologyGroups-getAllGroups-title-403"></h3>
+ <p id="examples-TopologyGroups-getAllGroups-description-403" class="marked"></p>
<script>
- var responseSchemas403_description = `Forbidden`;
- var responseSchemas403_description_break = responseSchemas403_description.indexOf('\n');
- if (responseSchemas403_description_break == -1) {
- $("#examples-Schemas-deleteSchema-title-403").text("Status: 403 - " + responseSchemas403_description);
+ var responseTopologyGroups403_description = `Forbidden`;
+ var responseTopologyGroups403_description_break = responseTopologyGroups403_description.indexOf('\n');
+ if (responseTopologyGroups403_description_break == -1) {
+ $("#examples-TopologyGroups-getAllGroups-title-403").text("Status: 403 - " + responseTopologyGroups403_description);
} else {
- $("#examples-Schemas-deleteSchema-title-403").text("Status: 403 - " + responseSchemas403_description.substring(0, responseSchemas403_description_break));
- $("#examples-Schemas-deleteSchema-description-403").html(responseSchemas403_description.substring(responseSchemas403_description_break));
+ $("#examples-TopologyGroups-getAllGroups-title-403").text("Status: 403 - " + responseTopologyGroups403_description.substring(0, responseTopologyGroups403_description_break));
+ $("#examples-TopologyGroups-getAllGroups-description-403").html(responseTopologyGroups403_description.substring(responseTopologyGroups403_description_break));
}
</script>
- <ul id="responses-detail-Schemas-deleteSchema-403" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-TopologyGroups-getAllGroups-403" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-deleteSchema-403-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-TopologyGroups-getAllGroups-403-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-deleteSchema-403-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-deleteSchema-403-schema">
- <div id="responses-Schemas-deleteSchema-schema-403" class="exampleStyle">
+ <div class="tab-content" id="responses-TopologyGroups-getAllGroups-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-TopologyGroups-getAllGroups-403-schema">
+ <div id="responses-TopologyGroups-getAllGroups-schema-403" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-deleteSchema-403-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-deleteSchema-schema-403');
+ $('#responses-TopologyGroups-getAllGroups-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-TopologyGroups-getAllGroups-schema-403');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-deleteSchema-403-schema-data' type='hidden' value=''></input>
+ <input id='responses-TopologyGroups-getAllGroups-403-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-deleteSchema-title-500"></h3>
- <p id="examples-Schemas-deleteSchema-description-500" class="marked"></p>
+ <h3 id="examples-TopologyGroups-getAllGroups-title-500"></h3>
+ <p id="examples-TopologyGroups-getAllGroups-description-500" class="marked"></p>
<script>
- var responseSchemas500_description = `Internal Server Error`;
- var responseSchemas500_description_break = responseSchemas500_description.indexOf('\n');
- if (responseSchemas500_description_break == -1) {
- $("#examples-Schemas-deleteSchema-title-500").text("Status: 500 - " + responseSchemas500_description);
+ var responseTopologyGroups500_description = `Internal Server Error`;
+ var responseTopologyGroups500_description_break = responseTopologyGroups500_description.indexOf('\n');
+ if (responseTopologyGroups500_description_break == -1) {
+ $("#examples-TopologyGroups-getAllGroups-title-500").text("Status: 500 - " + responseTopologyGroups500_description);
} else {
- $("#examples-Schemas-deleteSchema-title-500").text("Status: 500 - " + responseSchemas500_description.substring(0, responseSchemas500_description_break));
- $("#examples-Schemas-deleteSchema-description-500").html(responseSchemas500_description.substring(responseSchemas500_description_break));
+ $("#examples-TopologyGroups-getAllGroups-title-500").text("Status: 500 - " + responseTopologyGroups500_description.substring(0, responseTopologyGroups500_description_break));
+ $("#examples-TopologyGroups-getAllGroups-description-500").html(responseTopologyGroups500_description.substring(responseTopologyGroups500_description_break));
}
</script>
- <ul id="responses-detail-Schemas-deleteSchema-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-TopologyGroups-getAllGroups-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-deleteSchema-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-TopologyGroups-getAllGroups-500-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-deleteSchema-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-deleteSchema-500-schema">
- <div id="responses-Schemas-deleteSchema-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-TopologyGroups-getAllGroups-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-TopologyGroups-getAllGroups-500-schema">
+ <div id="responses-TopologyGroups-getAllGroups-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-deleteSchema-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-deleteSchema-schema-500');
+ $('#responses-TopologyGroups-getAllGroups-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-TopologyGroups-getAllGroups-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-deleteSchema-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-TopologyGroups-getAllGroups-500-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- <div id="api-Schemas-getSchemaByName">
- <article id="api-Schemas-getSchemaByName-0" data-group="User" data-name="getSchemaByName" data-version="0">
+ <div id="api-TopologyGroups-getGroup">
+ <article id="api-TopologyGroups-getGroup-0" data-group="User" data-name="getGroup" data-version="0">
<div class="pull-left">
- <h1>getSchemaByName</h1>
- <p>Get the model schema.</p>
+ <h1>getGroup</h1>
+ <p>Get a group with specified id.</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Get the model schema by name.</p>
+ <p class="marked">Get a Group with specified id.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/schemas/{schemaName}/content</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/groups/{groupId}</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
- <li class="active"><a href="#examples-Schemas-getSchemaByName-0-curl">Curl</a></li>
- <li class=""><a href="#examples-Schemas-getSchemaByName-0-java">Java</a></li>
- <li class=""><a href="#examples-Schemas-getSchemaByName-0-dart">Dart</a></li>
- <li class=""><a href="#examples-Schemas-getSchemaByName-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-Schemas-getSchemaByName-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-Schemas-getSchemaByName-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-Schemas-getSchemaByName-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-Schemas-getSchemaByName-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-Schemas-getSchemaByName-0-csharp">C#</a></li>
- <li class=""><a href="#examples-Schemas-getSchemaByName-0-php">PHP</a></li>
- <li class=""><a href="#examples-Schemas-getSchemaByName-0-perl">Perl</a></li>
- <li class=""><a href="#examples-Schemas-getSchemaByName-0-python">Python</a></li>
- <li class=""><a href="#examples-Schemas-getSchemaByName-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-TopologyGroups-getGroup-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-TopologyGroups-getGroup-0-java">Java</a></li>
+ <li class=""><a href="#examples-TopologyGroups-getGroup-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-TopologyGroups-getGroup-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-TopologyGroups-getGroup-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-TopologyGroups-getGroup-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-TopologyGroups-getGroup-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-TopologyGroups-getGroup-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-TopologyGroups-getGroup-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-TopologyGroups-getGroup-0-php">PHP</a></li>
+ <li class=""><a href="#examples-TopologyGroups-getGroup-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-TopologyGroups-getGroup-0-python">Python</a></li>
+ <li class=""><a href="#examples-TopologyGroups-getGroup-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-Schemas-getSchemaByName-0-curl">
+ <div class="tab-pane active" id="examples-TopologyGroups-getGroup-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X GET \
- -H "Accept: text/plain,application/problem+json" \
- "https://localhost/topology-inventory/v1alpha11/schemas/{schemaName}/content"
+ -H "Accept: application/json,application/problem+json" \
+ "https://localhost/topology-inventory/v1alpha11/groups/{groupId}"
</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-java">
+ <div class="tab-pane" id="examples-TopologyGroups-getGroup-0-java">
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
-import org.openapitools.client.api.SchemasApi;
+import org.openapitools.client.api.TopologyGroupsApi;
import java.io.File;
import java.util.*;
-public class SchemasApiExample {
+public class TopologyGroupsApiExample {
public static void main(String[] args) {
// Create an instance of the API class
- SchemasApi apiInstance = new SchemasApi();
+ TopologyGroupsApi apiInstance = new TopologyGroupsApi();
String accept = application/json; // String |
- String schemaName = schemaName_example; // String |
+ String groupId = groupId_example; // String |
try {
- 'String' result = apiInstance.getSchemaByName(accept, schemaName);
+ GroupResponse result = apiInstance.getGroup(accept, groupId);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling SchemasApi#getSchemaByName");
+ System.err.println("Exception when calling TopologyGroupsApi#getGroup");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-dart">
+ <div class="tab-pane" id="examples-TopologyGroups-getGroup-0-dart">
<pre class="prettyprint"><code class="language-dart">import 'package:openapi/api.dart';
final api_instance = DefaultApi();
final String accept = new String(); // String |
-final String schemaName = new String(); // String |
+final String groupId = new String(); // String |
try {
- final result = await api_instance.getSchemaByName(accept, schemaName);
+ final result = await api_instance.getGroup(accept, groupId);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->getSchemaByName: $e\n');
+ print('Exception when calling DefaultApi->getGroup: $e\n');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.SchemasApi;
+ <div class="tab-pane" id="examples-TopologyGroups-getGroup-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.TopologyGroupsApi;
-public class SchemasApiExample {
+public class TopologyGroupsApiExample {
public static void main(String[] args) {
- SchemasApi apiInstance = new SchemasApi();
+ TopologyGroupsApi apiInstance = new TopologyGroupsApi();
String accept = application/json; // String |
- String schemaName = schemaName_example; // String |
+ String groupId = groupId_example; // String |
try {
- 'String' result = apiInstance.getSchemaByName(accept, schemaName);
+ GroupResponse result = apiInstance.getGroup(accept, groupId);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling SchemasApi#getSchemaByName");
+ System.err.println("Exception when calling TopologyGroupsApi#getGroup");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-groovy">
+ <div class="tab-pane" id="examples-TopologyGroups-getGroup-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-objc">
+ <div class="tab-pane" id="examples-TopologyGroups-getGroup-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// Create an instance of the API class
-SchemasApi *apiInstance = [[SchemasApi alloc] init];
+TopologyGroupsApi *apiInstance = [[TopologyGroupsApi alloc] init];
String *accept = application/json; // (default to application/json)
-String *schemaName = schemaName_example; // (default to o-ran-smo-teiv-ran)
+String *groupId = groupId_example; // (default to null)
-// Get the model schema.
-[apiInstance getSchemaByNameWith:accept
- schemaName:schemaName
- completionHandler: ^('String' output, NSError* error) {
+// Get a group with specified id.
+[apiInstance getGroupWith:accept
+ groupId:groupId
+ completionHandler: ^(GroupResponse output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-javascript">
- <pre class="prettyprint"><code class="language-js">var TopologyAndInventoryApi = require('topology_and_inventory_api');
+ <div class="tab-pane" id="examples-TopologyGroups-getGroup-0-javascript">
+ <pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
-var api = new TopologyAndInventoryApi.SchemasApi()
+var api = new TopologyExposureAndInventoryApi.TopologyGroupsApi()
var accept = application/json; // {String}
-var schemaName = schemaName_example; // {String}
+var groupId = groupId_example; // {String}
var callback = function(error, data, response) {
if (error) {
console.log('API called successfully. Returned data: ' + data);
}
};
-api.getSchemaByName(accept, schemaName, callback);
+api.getGroup(accept, groupId, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-Schemas-getSchemaByName-0-angular">
+ <!--<div class="tab-pane" id="examples-TopologyGroups-getGroup-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-csharp">
+ <div class="tab-pane" id="examples-TopologyGroups-getGroup-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class getSchemaByNameExample
+ public class getGroupExample
{
public void main()
{
// Create an instance of the API class
- var apiInstance = new SchemasApi();
+ var apiInstance = new TopologyGroupsApi();
var accept = application/json; // String | (default to application/json)
- var schemaName = schemaName_example; // String | (default to o-ran-smo-teiv-ran)
+ var groupId = groupId_example; // String | (default to null)
try {
- // Get the model schema.
- 'String' result = apiInstance.getSchemaByName(accept, schemaName);
+ // Get a group with specified id.
+ GroupResponse result = apiInstance.getGroup(accept, groupId);
Debug.WriteLine(result);
} catch (Exception e) {
- Debug.Print("Exception when calling SchemasApi.getSchemaByName: " + e.Message );
+ Debug.Print("Exception when calling TopologyGroupsApi.getGroup: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-php">
+ <div class="tab-pane" id="examples-TopologyGroups-getGroup-0-php">
<pre class="prettyprint"><code class="language-php"><?php
require_once(__DIR__ . '/vendor/autoload.php');
// Create an instance of the API class
-$api_instance = new OpenAPITools\Client\Api\SchemasApi();
+$api_instance = new OpenAPITools\Client\Api\TopologyGroupsApi();
$accept = application/json; // String |
-$schemaName = schemaName_example; // String |
+$groupId = groupId_example; // String |
try {
- $result = $api_instance->getSchemaByName($accept, $schemaName);
+ $result = $api_instance->getGroup($accept, $groupId);
print_r($result);
} catch (Exception $e) {
- echo 'Exception when calling SchemasApi->getSchemaByName: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling TopologyGroupsApi->getGroup: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-perl">
+ <div class="tab-pane" id="examples-TopologyGroups-getGroup-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::SchemasApi;
+use WWW::OPenAPIClient::TopologyGroupsApi;
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::SchemasApi->new();
+my $api_instance = WWW::OPenAPIClient::TopologyGroupsApi->new();
my $accept = application/json; # String |
-my $schemaName = schemaName_example; # String |
+my $groupId = groupId_example; # String |
eval {
- my $result = $api_instance->getSchemaByName(accept => $accept, schemaName => $schemaName);
+ my $result = $api_instance->getGroup(accept => $accept, groupId => $groupId);
print Dumper($result);
};
if ($@) {
- warn "Exception when calling SchemasApi->getSchemaByName: $@\n";
+ warn "Exception when calling TopologyGroupsApi->getGroup: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-python">
+ <div class="tab-pane" id="examples-TopologyGroups-getGroup-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import openapi_client
from pprint import pprint
# Create an instance of the API class
-api_instance = openapi_client.SchemasApi()
+api_instance = openapi_client.TopologyGroupsApi()
accept = application/json # String | (default to application/json)
-schemaName = schemaName_example # String | (default to o-ran-smo-teiv-ran)
+groupId = groupId_example # String | (default to null)
try:
- # Get the model schema.
- api_response = api_instance.get_schema_by_name(accept, schemaName)
+ # Get a group with specified id.
+ api_response = api_instance.get_group(accept, groupId)
pprint(api_response)
except ApiException as e:
- print("Exception when calling SchemasApi->getSchemaByName: %s\n" % e)</code></pre>
+ print("Exception when calling TopologyGroupsApi->getGroup: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-getSchemaByName-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate SchemasApi;
+ <div class="tab-pane" id="examples-TopologyGroups-getGroup-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate TopologyGroupsApi;
pub fn main() {
let accept = application/json; // String
- let schemaName = schemaName_example; // String
+ let groupId = groupId_example; // String
- let mut context = SchemasApi::Context::default();
- let result = client.getSchemaByName(accept, schemaName, &context).wait();
+ let mut context = TopologyGroupsApi::Context::default();
+ let result = client.getGroup(accept, groupId, &context).wait();
println!("{:?}", result);
}
<th width="150px">Name</th>
<th>Description</th>
</tr>
- <tr><td style="width:150px;">schemaName*</td>
+ <tr><td style="width:150px;">groupId*</td>
<td>
- <div id="d2e199_getSchemaByName_schemaName">
+ <div id="d2e199_getGroup_groupId">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
<td>
- <div id="d2e199_getSchemaByName_accept">
+ <div id="d2e199_getGroup_accept">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
<h2>Responses</h2>
- <h3 id="examples-Schemas-getSchemaByName-title-200"></h3>
- <p id="examples-Schemas-getSchemaByName-description-200" class="marked"></p>
+ <h3 id="examples-TopologyGroups-getGroup-title-200"></h3>
+ <p id="examples-TopologyGroups-getGroup-description-200" class="marked"></p>
<script>
- var responseSchemas200_description = `OK`;
- var responseSchemas200_description_break = responseSchemas200_description.indexOf('\n');
- if (responseSchemas200_description_break == -1) {
- $("#examples-Schemas-getSchemaByName-title-200").text("Status: 200 - " + responseSchemas200_description);
+ var responseTopologyGroups200_description = `OK`;
+ var responseTopologyGroups200_description_break = responseTopologyGroups200_description.indexOf('\n');
+ if (responseTopologyGroups200_description_break == -1) {
+ $("#examples-TopologyGroups-getGroup-title-200").text("Status: 200 - " + responseTopologyGroups200_description);
} else {
- $("#examples-Schemas-getSchemaByName-title-200").text("Status: 200 - " + responseSchemas200_description.substring(0, responseSchemas200_description_break));
- $("#examples-Schemas-getSchemaByName-description-200").html(responseSchemas200_description.substring(responseSchemas200_description_break));
+ $("#examples-TopologyGroups-getGroup-title-200").text("Status: 200 - " + responseTopologyGroups200_description.substring(0, responseTopologyGroups200_description_break));
+ $("#examples-TopologyGroups-getGroup-description-200").html(responseTopologyGroups200_description.substring(responseTopologyGroups200_description_break));
}
</script>
- <ul id="responses-detail-Schemas-getSchemaByName-200" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-TopologyGroups-getGroup-200" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-getSchemaByName-200-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-TopologyGroups-getGroup-200-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-getSchemaByName-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-getSchemaByName-200-schema">
- <div id="responses-Schemas-getSchemaByName-schema-200" class="exampleStyle">
+ <div class="tab-content" id="responses-TopologyGroups-getGroup-200-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-TopologyGroups-getGroup-200-schema">
+ <div id="responses-TopologyGroups-getGroup-schema-200" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "OK",
"content" : {
- "text/plain" : {
+ "application/json" : {
"schema" : {
- "type" : "string"
+ "$ref" : "#/components/schemas/GroupResponse"
},
"examples" : {
- "schema" : {
- "$ref" : "#/components/examples/SchemaResponseExample"
+ "group" : {
+ "$ref" : "#/components/examples/GroupResponseExample"
}
}
}
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-getSchemaByName-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-getSchemaByName-schema-200');
+ $('#responses-TopologyGroups-getGroup-200-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-TopologyGroups-getGroup-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-getSchemaByName-200-schema-data' type='hidden' value=''></input>
+ <input id='responses-TopologyGroups-getGroup-200-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-getSchemaByName-title-400"></h3>
- <p id="examples-Schemas-getSchemaByName-description-400" class="marked"></p>
+ <h3 id="examples-TopologyGroups-getGroup-title-400"></h3>
+ <p id="examples-TopologyGroups-getGroup-description-400" class="marked"></p>
<script>
- var responseSchemas400_description = `Bad Request`;
- var responseSchemas400_description_break = responseSchemas400_description.indexOf('\n');
- if (responseSchemas400_description_break == -1) {
- $("#examples-Schemas-getSchemaByName-title-400").text("Status: 400 - " + responseSchemas400_description);
+ var responseTopologyGroups400_description = `Bad Request`;
+ var responseTopologyGroups400_description_break = responseTopologyGroups400_description.indexOf('\n');
+ if (responseTopologyGroups400_description_break == -1) {
+ $("#examples-TopologyGroups-getGroup-title-400").text("Status: 400 - " + responseTopologyGroups400_description);
} else {
- $("#examples-Schemas-getSchemaByName-title-400").text("Status: 400 - " + responseSchemas400_description.substring(0, responseSchemas400_description_break));
- $("#examples-Schemas-getSchemaByName-description-400").html(responseSchemas400_description.substring(responseSchemas400_description_break));
+ $("#examples-TopologyGroups-getGroup-title-400").text("Status: 400 - " + responseTopologyGroups400_description.substring(0, responseTopologyGroups400_description_break));
+ $("#examples-TopologyGroups-getGroup-description-400").html(responseTopologyGroups400_description.substring(responseTopologyGroups400_description_break));
}
</script>
- <ul id="responses-detail-Schemas-getSchemaByName-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-TopologyGroups-getGroup-400" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-getSchemaByName-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-TopologyGroups-getGroup-400-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-getSchemaByName-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-getSchemaByName-400-schema">
- <div id="responses-Schemas-getSchemaByName-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-TopologyGroups-getGroup-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-TopologyGroups-getGroup-400-schema">
+ <div id="responses-TopologyGroups-getGroup-schema-400" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-getSchemaByName-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-getSchemaByName-schema-400');
+ $('#responses-TopologyGroups-getGroup-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-TopologyGroups-getGroup-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-getSchemaByName-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-TopologyGroups-getGroup-400-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-getSchemaByName-title-401"></h3>
- <p id="examples-Schemas-getSchemaByName-description-401" class="marked"></p>
+ <h3 id="examples-TopologyGroups-getGroup-title-401"></h3>
+ <p id="examples-TopologyGroups-getGroup-description-401" class="marked"></p>
<script>
- var responseSchemas401_description = `Unauthorized`;
- var responseSchemas401_description_break = responseSchemas401_description.indexOf('\n');
- if (responseSchemas401_description_break == -1) {
- $("#examples-Schemas-getSchemaByName-title-401").text("Status: 401 - " + responseSchemas401_description);
+ var responseTopologyGroups401_description = `Unauthorized`;
+ var responseTopologyGroups401_description_break = responseTopologyGroups401_description.indexOf('\n');
+ if (responseTopologyGroups401_description_break == -1) {
+ $("#examples-TopologyGroups-getGroup-title-401").text("Status: 401 - " + responseTopologyGroups401_description);
} else {
- $("#examples-Schemas-getSchemaByName-title-401").text("Status: 401 - " + responseSchemas401_description.substring(0, responseSchemas401_description_break));
- $("#examples-Schemas-getSchemaByName-description-401").html(responseSchemas401_description.substring(responseSchemas401_description_break));
+ $("#examples-TopologyGroups-getGroup-title-401").text("Status: 401 - " + responseTopologyGroups401_description.substring(0, responseTopologyGroups401_description_break));
+ $("#examples-TopologyGroups-getGroup-description-401").html(responseTopologyGroups401_description.substring(responseTopologyGroups401_description_break));
}
</script>
- <ul id="responses-detail-Schemas-getSchemaByName-401" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-TopologyGroups-getGroup-401" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-getSchemaByName-401-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-TopologyGroups-getGroup-401-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-getSchemaByName-401-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-getSchemaByName-401-schema">
- <div id="responses-Schemas-getSchemaByName-schema-401" class="exampleStyle">
+ <div class="tab-content" id="responses-TopologyGroups-getGroup-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-TopologyGroups-getGroup-401-schema">
+ <div id="responses-TopologyGroups-getGroup-schema-401" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-getSchemaByName-401-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-getSchemaByName-schema-401');
+ $('#responses-TopologyGroups-getGroup-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-TopologyGroups-getGroup-schema-401');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-getSchemaByName-401-schema-data' type='hidden' value=''></input>
+ <input id='responses-TopologyGroups-getGroup-401-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-getSchemaByName-title-403"></h3>
- <p id="examples-Schemas-getSchemaByName-description-403" class="marked"></p>
+ <h3 id="examples-TopologyGroups-getGroup-title-403"></h3>
+ <p id="examples-TopologyGroups-getGroup-description-403" class="marked"></p>
<script>
- var responseSchemas403_description = `Forbidden`;
- var responseSchemas403_description_break = responseSchemas403_description.indexOf('\n');
- if (responseSchemas403_description_break == -1) {
- $("#examples-Schemas-getSchemaByName-title-403").text("Status: 403 - " + responseSchemas403_description);
+ var responseTopologyGroups403_description = `Forbidden`;
+ var responseTopologyGroups403_description_break = responseTopologyGroups403_description.indexOf('\n');
+ if (responseTopologyGroups403_description_break == -1) {
+ $("#examples-TopologyGroups-getGroup-title-403").text("Status: 403 - " + responseTopologyGroups403_description);
} else {
- $("#examples-Schemas-getSchemaByName-title-403").text("Status: 403 - " + responseSchemas403_description.substring(0, responseSchemas403_description_break));
- $("#examples-Schemas-getSchemaByName-description-403").html(responseSchemas403_description.substring(responseSchemas403_description_break));
+ $("#examples-TopologyGroups-getGroup-title-403").text("Status: 403 - " + responseTopologyGroups403_description.substring(0, responseTopologyGroups403_description_break));
+ $("#examples-TopologyGroups-getGroup-description-403").html(responseTopologyGroups403_description.substring(responseTopologyGroups403_description_break));
}
</script>
- <ul id="responses-detail-Schemas-getSchemaByName-403" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-TopologyGroups-getGroup-403" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-getSchemaByName-403-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-TopologyGroups-getGroup-403-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-getSchemaByName-403-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-getSchemaByName-403-schema">
- <div id="responses-Schemas-getSchemaByName-schema-403" class="exampleStyle">
+ <div class="tab-content" id="responses-TopologyGroups-getGroup-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-TopologyGroups-getGroup-403-schema">
+ <div id="responses-TopologyGroups-getGroup-schema-403" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-getSchemaByName-403-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-getSchemaByName-schema-403');
+ $('#responses-TopologyGroups-getGroup-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-TopologyGroups-getGroup-schema-403');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-getSchemaByName-403-schema-data' type='hidden' value=''></input>
+ <input id='responses-TopologyGroups-getGroup-403-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-getSchemaByName-title-404"></h3>
- <p id="examples-Schemas-getSchemaByName-description-404" class="marked"></p>
+ <h3 id="examples-TopologyGroups-getGroup-title-404"></h3>
+ <p id="examples-TopologyGroups-getGroup-description-404" class="marked"></p>
<script>
- var responseSchemas404_description = `Not Found`;
- var responseSchemas404_description_break = responseSchemas404_description.indexOf('\n');
- if (responseSchemas404_description_break == -1) {
- $("#examples-Schemas-getSchemaByName-title-404").text("Status: 404 - " + responseSchemas404_description);
+ var responseTopologyGroups404_description = `Not Found`;
+ var responseTopologyGroups404_description_break = responseTopologyGroups404_description.indexOf('\n');
+ if (responseTopologyGroups404_description_break == -1) {
+ $("#examples-TopologyGroups-getGroup-title-404").text("Status: 404 - " + responseTopologyGroups404_description);
} else {
- $("#examples-Schemas-getSchemaByName-title-404").text("Status: 404 - " + responseSchemas404_description.substring(0, responseSchemas404_description_break));
- $("#examples-Schemas-getSchemaByName-description-404").html(responseSchemas404_description.substring(responseSchemas404_description_break));
+ $("#examples-TopologyGroups-getGroup-title-404").text("Status: 404 - " + responseTopologyGroups404_description.substring(0, responseTopologyGroups404_description_break));
+ $("#examples-TopologyGroups-getGroup-description-404").html(responseTopologyGroups404_description.substring(responseTopologyGroups404_description_break));
}
</script>
- <ul id="responses-detail-Schemas-getSchemaByName-404" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-TopologyGroups-getGroup-404" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-getSchemaByName-404-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-TopologyGroups-getGroup-404-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-getSchemaByName-404-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-getSchemaByName-404-schema">
- <div id="responses-Schemas-getSchemaByName-schema-404" class="exampleStyle">
+ <div class="tab-content" id="responses-TopologyGroups-getGroup-404-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-TopologyGroups-getGroup-404-schema">
+ <div id="responses-TopologyGroups-getGroup-schema-404" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-getSchemaByName-404-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-getSchemaByName-schema-404');
+ $('#responses-TopologyGroups-getGroup-404-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-TopologyGroups-getGroup-schema-404');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-getSchemaByName-404-schema-data' type='hidden' value=''></input>
+ <input id='responses-TopologyGroups-getGroup-404-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-getSchemaByName-title-500"></h3>
- <p id="examples-Schemas-getSchemaByName-description-500" class="marked"></p>
+ <h3 id="examples-TopologyGroups-getGroup-title-500"></h3>
+ <p id="examples-TopologyGroups-getGroup-description-500" class="marked"></p>
<script>
- var responseSchemas500_description = `Internal Server Error`;
- var responseSchemas500_description_break = responseSchemas500_description.indexOf('\n');
- if (responseSchemas500_description_break == -1) {
- $("#examples-Schemas-getSchemaByName-title-500").text("Status: 500 - " + responseSchemas500_description);
+ var responseTopologyGroups500_description = `Internal Server Error`;
+ var responseTopologyGroups500_description_break = responseTopologyGroups500_description.indexOf('\n');
+ if (responseTopologyGroups500_description_break == -1) {
+ $("#examples-TopologyGroups-getGroup-title-500").text("Status: 500 - " + responseTopologyGroups500_description);
} else {
- $("#examples-Schemas-getSchemaByName-title-500").text("Status: 500 - " + responseSchemas500_description.substring(0, responseSchemas500_description_break));
- $("#examples-Schemas-getSchemaByName-description-500").html(responseSchemas500_description.substring(responseSchemas500_description_break));
+ $("#examples-TopologyGroups-getGroup-title-500").text("Status: 500 - " + responseTopologyGroups500_description.substring(0, responseTopologyGroups500_description_break));
+ $("#examples-TopologyGroups-getGroup-description-500").html(responseTopologyGroups500_description.substring(responseTopologyGroups500_description_break));
}
</script>
- <ul id="responses-detail-Schemas-getSchemaByName-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-TopologyGroups-getGroup-500" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-getSchemaByName-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-TopologyGroups-getGroup-500-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-getSchemaByName-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-getSchemaByName-500-schema">
- <div id="responses-Schemas-getSchemaByName-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-TopologyGroups-getGroup-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-TopologyGroups-getGroup-500-schema">
+ <div id="responses-TopologyGroups-getGroup-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-getSchemaByName-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-getSchemaByName-schema-500');
+ $('#responses-TopologyGroups-getGroup-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-TopologyGroups-getGroup-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-getSchemaByName-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-TopologyGroups-getGroup-500-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
</div>
<hr>
- <div id="api-Schemas-getSchemas">
- <article id="api-Schemas-getSchemas-0" data-group="User" data-name="getSchemas" data-version="0">
+ <div id="api-TopologyGroups-updateGroup">
+ <article id="api-TopologyGroups-updateGroup-0" data-group="User" data-name="updateGroup" data-version="0">
<div class="pull-left">
- <h1>getSchemas</h1>
- <p>Get a list of all schemas.</p>
+ <h1>updateGroup</h1>
+ <p>Update a Group.</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
- <p class="marked">Get a list of all schemas.</p>
+ <p class="marked">Update a Group.</p>
<p></p>
<br />
- <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/schemas</span></code></pre>
+ <pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/groups/{groupId}</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
- <li class="active"><a href="#examples-Schemas-getSchemas-0-curl">Curl</a></li>
- <li class=""><a href="#examples-Schemas-getSchemas-0-java">Java</a></li>
- <li class=""><a href="#examples-Schemas-getSchemas-0-dart">Dart</a></li>
- <li class=""><a href="#examples-Schemas-getSchemas-0-android">Android</a></li>
- <!--<li class=""><a href="#examples-Schemas-getSchemas-0-groovy">Groovy</a></li>-->
- <li class=""><a href="#examples-Schemas-getSchemas-0-objc">Obj-C</a></li>
- <li class=""><a href="#examples-Schemas-getSchemas-0-javascript">JavaScript</a></li>
- <!--<li class=""><a href="#examples-Schemas-getSchemas-0-angular">Angular</a></li>-->
- <li class=""><a href="#examples-Schemas-getSchemas-0-csharp">C#</a></li>
- <li class=""><a href="#examples-Schemas-getSchemas-0-php">PHP</a></li>
- <li class=""><a href="#examples-Schemas-getSchemas-0-perl">Perl</a></li>
- <li class=""><a href="#examples-Schemas-getSchemas-0-python">Python</a></li>
- <li class=""><a href="#examples-Schemas-getSchemas-0-rust">Rust</a></li>
+ <li class="active"><a href="#examples-TopologyGroups-updateGroup-0-curl">Curl</a></li>
+ <li class=""><a href="#examples-TopologyGroups-updateGroup-0-java">Java</a></li>
+ <li class=""><a href="#examples-TopologyGroups-updateGroup-0-dart">Dart</a></li>
+ <li class=""><a href="#examples-TopologyGroups-updateGroup-0-android">Android</a></li>
+ <!--<li class=""><a href="#examples-TopologyGroups-updateGroup-0-groovy">Groovy</a></li>-->
+ <li class=""><a href="#examples-TopologyGroups-updateGroup-0-objc">Obj-C</a></li>
+ <li class=""><a href="#examples-TopologyGroups-updateGroup-0-javascript">JavaScript</a></li>
+ <!--<li class=""><a href="#examples-TopologyGroups-updateGroup-0-angular">Angular</a></li>-->
+ <li class=""><a href="#examples-TopologyGroups-updateGroup-0-csharp">C#</a></li>
+ <li class=""><a href="#examples-TopologyGroups-updateGroup-0-php">PHP</a></li>
+ <li class=""><a href="#examples-TopologyGroups-updateGroup-0-perl">Perl</a></li>
+ <li class=""><a href="#examples-TopologyGroups-updateGroup-0-python">Python</a></li>
+ <li class=""><a href="#examples-TopologyGroups-updateGroup-0-rust">Rust</a></li>
</ul>
<div class="tab-content">
- <div class="tab-pane active" id="examples-Schemas-getSchemas-0-curl">
- <pre class="prettyprint"><code class="language-bsh">curl -X GET \
- -H "Accept: application/json,application/problem+json" \
- "https://localhost/topology-inventory/v1alpha11/schemas?domain=ran&offset=56&limit=56"
+ <div class="tab-pane active" id="examples-TopologyGroups-updateGroup-0-curl">
+ <pre class="prettyprint"><code class="language-bsh">curl -X PUT \
+ -H "Accept: application/problem+json" \
+ -H "Content-Type: application/json" \
+ "https://localhost/topology-inventory/v1alpha11/groups/{groupId}" \
+ -d '{
+ "groupName" : "groupName",
+ "criteria" : {
+ "resourceInstances" : [ "resourceInstances", "resourceInstances" ]
+ }
+}'
</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-getSchemas-0-java">
+ <div class="tab-pane" id="examples-TopologyGroups-updateGroup-0-java">
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
-import org.openapitools.client.api.SchemasApi;
+import org.openapitools.client.api.TopologyGroupsApi;
import java.io.File;
import java.util.*;
-public class SchemasApiExample {
+public class TopologyGroupsApiExample {
public static void main(String[] args) {
// Create an instance of the API class
- SchemasApi apiInstance = new SchemasApi();
+ TopologyGroupsApi apiInstance = new TopologyGroupsApi();
String accept = application/json; // String |
- String domain = ran; // String |
- Integer offset = 56; // Integer | Pagination offset.
- Integer limit = 56; // Integer | Result limiter.
+ String contentType = application/json; // String |
+ String groupId = groupId_example; // String |
+ Group group = ; // Group |
try {
- SchemaList result = apiInstance.getSchemas(accept, domain, offset, limit);
- System.out.println(result);
+ apiInstance.updateGroup(accept, contentType, groupId, group);
} catch (ApiException e) {
- System.err.println("Exception when calling SchemasApi#getSchemas");
+ System.err.println("Exception when calling TopologyGroupsApi#updateGroup");
e.printStackTrace();
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-getSchemas-0-dart">
+ <div class="tab-pane" id="examples-TopologyGroups-updateGroup-0-dart">
<pre class="prettyprint"><code class="language-dart">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.
+final String contentType = new String(); // String |
+final String groupId = new String(); // String |
+final Group group = new Group(); // Group |
try {
- final result = await api_instance.getSchemas(accept, domain, offset, limit);
+ final result = await api_instance.updateGroup(accept, contentType, groupId, group);
print(result);
} catch (e) {
- print('Exception when calling DefaultApi->getSchemas: $e\n');
+ print('Exception when calling DefaultApi->updateGroup: $e\n');
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-getSchemas-0-android">
- <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.SchemasApi;
+ <div class="tab-pane" id="examples-TopologyGroups-updateGroup-0-android">
+ <pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.TopologyGroupsApi;
-public class SchemasApiExample {
+public class TopologyGroupsApiExample {
public static void main(String[] args) {
- SchemasApi apiInstance = new SchemasApi();
+ TopologyGroupsApi apiInstance = new TopologyGroupsApi();
String accept = application/json; // String |
- String domain = ran; // String |
- Integer offset = 56; // Integer | Pagination offset.
- Integer limit = 56; // Integer | Result limiter.
+ String contentType = application/json; // String |
+ String groupId = groupId_example; // String |
+ Group group = ; // Group |
try {
- SchemaList result = apiInstance.getSchemas(accept, domain, offset, limit);
- System.out.println(result);
+ apiInstance.updateGroup(accept, contentType, groupId, group);
} catch (ApiException e) {
- System.err.println("Exception when calling SchemasApi#getSchemas");
+ System.err.println("Exception when calling TopologyGroupsApi#updateGroup");
e.printStackTrace();
}
}
}</code></pre>
</div>
<!--
- <div class="tab-pane" id="examples-Schemas-getSchemas-0-groovy">
+ <div class="tab-pane" id="examples-TopologyGroups-updateGroup-0-groovy">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div> -->
- <div class="tab-pane" id="examples-Schemas-getSchemas-0-objc">
+ <div class="tab-pane" id="examples-TopologyGroups-updateGroup-0-objc">
<pre class="prettyprint"><code class="language-cpp">
// Create an instance of the API class
-SchemasApi *apiInstance = [[SchemasApi alloc] init];
+TopologyGroupsApi *apiInstance = [[TopologyGroupsApi 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)
+String *contentType = application/json; // (default to application/json)
+String *groupId = groupId_example; // (default to null)
+Group *group = ; //
-// Get a list of all schemas.
-[apiInstance getSchemasWith:accept
- domain:domain
- offset:offset
- limit:limit
- completionHandler: ^(SchemaList output, NSError* error) {
- if (output) {
- NSLog(@"%@", output);
- }
+// Update a Group.
+[apiInstance updateGroupWith:accept
+ contentType:contentType
+ groupId:groupId
+ group:group
+ completionHandler: ^(NSError* error) {
if (error) {
NSLog(@"Error: %@", error);
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-getSchemas-0-javascript">
- <pre class="prettyprint"><code class="language-js">var TopologyAndInventoryApi = require('topology_and_inventory_api');
+ <div class="tab-pane" id="examples-TopologyGroups-updateGroup-0-javascript">
+ <pre class="prettyprint"><code class="language-js">var TopologyExposureAndInventoryApi = require('topology_exposure_and_inventory_api');
// Create an instance of the API class
-var api = new TopologyAndInventoryApi.SchemasApi()
+var api = new TopologyExposureAndInventoryApi.TopologyGroupsApi()
var accept = application/json; // {String}
-var opts = {
- 'domain': ran, // {String}
- 'offset': 56, // {Integer} Pagination offset.
- 'limit': 56 // {Integer} Result limiter.
-};
+var contentType = application/json; // {String}
+var groupId = groupId_example; // {String}
+var group = ; // {Group}
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.getSchemas(accept, opts, callback);
+api.updateGroup(accept, contentType, groupId, group, callback);
</code></pre>
</div>
- <!--<div class="tab-pane" id="examples-Schemas-getSchemas-0-angular">
+ <!--<div class="tab-pane" id="examples-TopologyGroups-updateGroup-0-angular">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre>
</div>-->
- <div class="tab-pane" id="examples-Schemas-getSchemas-0-csharp">
+ <div class="tab-pane" id="examples-TopologyGroups-updateGroup-0-csharp">
<pre class="prettyprint"><code class="language-cs">using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
namespace Example
{
- public class getSchemasExample
+ public class updateGroupExample
{
public void main()
{
// Create an instance of the API class
- var apiInstance = new SchemasApi();
+ var apiInstance = new TopologyGroupsApi();
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)
+ var contentType = application/json; // String | (default to application/json)
+ var groupId = groupId_example; // String | (default to null)
+ var group = new Group(); // Group |
try {
- // Get a list of all schemas.
- SchemaList result = apiInstance.getSchemas(accept, domain, offset, limit);
- Debug.WriteLine(result);
+ // Update a Group.
+ apiInstance.updateGroup(accept, contentType, groupId, group);
} catch (Exception e) {
- Debug.Print("Exception when calling SchemasApi.getSchemas: " + e.Message );
+ Debug.Print("Exception when calling TopologyGroupsApi.updateGroup: " + e.Message );
}
}
}
</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-getSchemas-0-php">
+ <div class="tab-pane" id="examples-TopologyGroups-updateGroup-0-php">
<pre class="prettyprint"><code class="language-php"><?php
require_once(__DIR__ . '/vendor/autoload.php');
// Create an instance of the API class
-$api_instance = new OpenAPITools\Client\Api\SchemasApi();
+$api_instance = new OpenAPITools\Client\Api\TopologyGroupsApi();
$accept = application/json; // String |
-$domain = ran; // String |
-$offset = 56; // Integer | Pagination offset.
-$limit = 56; // Integer | Result limiter.
+$contentType = application/json; // String |
+$groupId = groupId_example; // String |
+$group = ; // Group |
try {
- $result = $api_instance->getSchemas($accept, $domain, $offset, $limit);
- print_r($result);
+ $api_instance->updateGroup($accept, $contentType, $groupId, $group);
} catch (Exception $e) {
- echo 'Exception when calling SchemasApi->getSchemas: ', $e->getMessage(), PHP_EOL;
+ echo 'Exception when calling TopologyGroupsApi->updateGroup: ', $e->getMessage(), PHP_EOL;
}
?></code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-getSchemas-0-perl">
+ <div class="tab-pane" id="examples-TopologyGroups-updateGroup-0-perl">
<pre class="prettyprint"><code class="language-perl">use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
-use WWW::OPenAPIClient::SchemasApi;
+use WWW::OPenAPIClient::TopologyGroupsApi;
# Create an instance of the API class
-my $api_instance = WWW::OPenAPIClient::SchemasApi->new();
+my $api_instance = WWW::OPenAPIClient::TopologyGroupsApi->new();
my $accept = application/json; # String |
-my $domain = ran; # String |
-my $offset = 56; # Integer | Pagination offset.
-my $limit = 56; # Integer | Result limiter.
+my $contentType = application/json; # String |
+my $groupId = groupId_example; # String |
+my $group = WWW::OPenAPIClient::Object::Group->new(); # Group |
eval {
- my $result = $api_instance->getSchemas(accept => $accept, domain => $domain, offset => $offset, limit => $limit);
- print Dumper($result);
+ $api_instance->updateGroup(accept => $accept, contentType => $contentType, groupId => $groupId, group => $group);
};
if ($@) {
- warn "Exception when calling SchemasApi->getSchemas: $@\n";
+ warn "Exception when calling TopologyGroupsApi->updateGroup: $@\n";
}</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-getSchemas-0-python">
+ <div class="tab-pane" id="examples-TopologyGroups-updateGroup-0-python">
<pre class="prettyprint"><code class="language-python">from __future__ import print_statement
import time
import openapi_client
from pprint import pprint
# Create an instance of the API class
-api_instance = openapi_client.SchemasApi()
+api_instance = openapi_client.TopologyGroupsApi()
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)
+contentType = application/json # String | (default to application/json)
+groupId = groupId_example # String | (default to null)
+group = # Group |
try:
- # Get a list of all schemas.
- api_response = api_instance.get_schemas(accept, domain=domain, offset=offset, limit=limit)
- pprint(api_response)
+ # Update a Group.
+ api_instance.update_group(accept, contentType, groupId, group)
except ApiException as e:
- print("Exception when calling SchemasApi->getSchemas: %s\n" % e)</code></pre>
+ print("Exception when calling TopologyGroupsApi->updateGroup: %s\n" % e)</code></pre>
</div>
- <div class="tab-pane" id="examples-Schemas-getSchemas-0-rust">
- <pre class="prettyprint"><code class="language-rust">extern crate SchemasApi;
+ <div class="tab-pane" id="examples-TopologyGroups-updateGroup-0-rust">
+ <pre class="prettyprint"><code class="language-rust">extern crate TopologyGroupsApi;
pub fn main() {
let accept = application/json; // String
- let domain = ran; // String
- let offset = 56; // Integer
- let limit = 56; // Integer
+ let contentType = application/json; // String
+ let groupId = groupId_example; // String
+ let group = ; // Group
- let mut context = SchemasApi::Context::default();
- let result = client.getSchemas(accept, domain, offset, limit, &context).wait();
+ let mut context = TopologyGroupsApi::Context::default();
+ let result = client.updateGroup(accept, contentType, groupId, group, &context).wait();
println!("{:?}", result);
}
<h2>Parameters</h2>
-
- <div class="methodsubtabletitle">Header parameters</div>
+ <div class="methodsubtabletitle">Path parameters</div>
<table id="methodsubtable">
- <tr>
- <th width="150px">Name</th>
- <th>Description</th>
- </tr>
- <tr><td style="width:150px;">Accept*</td>
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">groupId*</td>
<td>
- <div id="d2e199_getSchemas_accept">
+ <div id="d2e199_updateGroup_groupId">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
</table>
-
-
- <div class="methodsubtabletitle">Query parameters</div>
+ <div class="methodsubtabletitle">Header parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
- <tr><td style="width:150px;">domain</td>
+ <tr><td style="width:150px;">Accept*</td>
<td>
- <div id="d2e199_getSchemas_domain">
+ <div id="d2e199_updateGroup_accept">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
</span>
</div>
+ <div class="inner required">
+ Required
+ </div>
</div>
</div>
</td>
</tr>
- <tr><td style="width:150px;">offset</td>
+ <tr><td style="width:150px;">Content-Type*</td>
<td>
- <div id="d2e199_getSchemas_offset">
+ <div id="d2e199_updateGroup_contentType">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
- Integer
+ String
</span>
- <div class="inner description marked">
-Pagination offset.
- </div>
</div>
+ <div class="inner required">
+ Required
+ </div>
</div>
</div>
</td>
</tr>
- <tr><td style="width:150px;">limit</td>
-<td>
+ </table>
+ <div class="methodsubtabletitle">Body parameters</div>
+ <table id="methodsubtable">
+ <tr>
+ <th width="150px">Name</th>
+ <th>Description</th>
+ </tr>
+ <tr><td style="width:150px;">group <span style="color:red;">*</span></td>
+<td>
+<p class="marked"></p>
+<script>
+$(document).ready(function() {
+ var schemaWrapper = {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/Group"
+ },
+ "examples" : {
+ "dynamicGroup" : {
+ "$ref" : "#/components/examples/DynamicGroupExample"
+ },
+ "staticGroup" : {
+ "$ref" : "#/components/examples/StaticGroupExample"
+ }
+ }
+ }
+ },
+ "required" : true
+};
- <div id="d2e199_getSchemas_limit">
- <div class="json-schema-view">
- <div class="primitive">
- <span class="type">
- Integer
- </span>
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
- <div class="inner description marked">
-Result limiter.
- </div>
- </div>
- </div>
- </div>
+ var view = new JSONSchemaView(schema,2,{isBodyParam: true});
+ var result = $('#d2e199_updateGroup_group');
+ result.empty();
+ result.append(view.render());
+});
+</script>
+<div id="d2e199_updateGroup_group"></div>
</td>
</tr>
</table>
+
+
<h2>Responses</h2>
- <h3 id="examples-Schemas-getSchemas-title-200"></h3>
- <p id="examples-Schemas-getSchemas-description-200" class="marked"></p>
+ <h3 id="examples-TopologyGroups-updateGroup-title-204"></h3>
+ <p id="examples-TopologyGroups-updateGroup-description-204" class="marked"></p>
<script>
- var responseSchemas200_description = `OK`;
- var responseSchemas200_description_break = responseSchemas200_description.indexOf('\n');
- if (responseSchemas200_description_break == -1) {
- $("#examples-Schemas-getSchemas-title-200").text("Status: 200 - " + responseSchemas200_description);
+ var responseTopologyGroups204_description = `No Content`;
+ var responseTopologyGroups204_description_break = responseTopologyGroups204_description.indexOf('\n');
+ if (responseTopologyGroups204_description_break == -1) {
+ $("#examples-TopologyGroups-updateGroup-title-204").text("Status: 204 - " + responseTopologyGroups204_description);
} else {
- $("#examples-Schemas-getSchemas-title-200").text("Status: 200 - " + responseSchemas200_description.substring(0, responseSchemas200_description_break));
- $("#examples-Schemas-getSchemas-description-200").html(responseSchemas200_description.substring(responseSchemas200_description_break));
+ $("#examples-TopologyGroups-updateGroup-title-204").text("Status: 204 - " + responseTopologyGroups204_description.substring(0, responseTopologyGroups204_description_break));
+ $("#examples-TopologyGroups-updateGroup-description-204").html(responseTopologyGroups204_description.substring(responseTopologyGroups204_description_break));
}
</script>
- <ul id="responses-detail-Schemas-getSchemas-200" class="nav nav-tabs nav-tabs-examples" >
- <li class="active">
- <a data-toggle="tab" href="#responses-Schemas-getSchemas-200-schema">Schema</a>
- </li>
-
-
+ <ul id="responses-detail-TopologyGroups-updateGroup-204" class="nav nav-tabs nav-tabs-examples" >
</ul>
- <div class="tab-content" id="responses-Schemas-getSchemas-200-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-getSchemas-200-schema">
- <div id="responses-Schemas-getSchemas-schema-200" class="exampleStyle">
+ <div class="tab-content" id="responses-TopologyGroups-updateGroup-204-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-TopologyGroups-updateGroup-204-schema">
+ <div id="responses-TopologyGroups-updateGroup-schema-204" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
- "description" : "OK",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/SchemaList"
- },
- "examples" : {
- "schemas" : {
- "$ref" : "#/components/examples/SchemasResponseExample"
- }
- }
- }
- }
+ "description" : "No Content",
+ "content" : { }
};
var schema = findNode('schema',schemaWrapper).schema;
if (!schema) {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-getSchemas-200-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-getSchemas-schema-200');
+ $('#responses-TopologyGroups-updateGroup-204-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-TopologyGroups-updateGroup-schema-204');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-getSchemas-200-schema-data' type='hidden' value=''></input>
+ <input id='responses-TopologyGroups-updateGroup-204-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-getSchemas-title-400"></h3>
- <p id="examples-Schemas-getSchemas-description-400" class="marked"></p>
+ <h3 id="examples-TopologyGroups-updateGroup-title-400"></h3>
+ <p id="examples-TopologyGroups-updateGroup-description-400" class="marked"></p>
<script>
- var responseSchemas400_description = `Bad Request`;
- var responseSchemas400_description_break = responseSchemas400_description.indexOf('\n');
- if (responseSchemas400_description_break == -1) {
- $("#examples-Schemas-getSchemas-title-400").text("Status: 400 - " + responseSchemas400_description);
+ var responseTopologyGroups400_description = `Bad Request`;
+ var responseTopologyGroups400_description_break = responseTopologyGroups400_description.indexOf('\n');
+ if (responseTopologyGroups400_description_break == -1) {
+ $("#examples-TopologyGroups-updateGroup-title-400").text("Status: 400 - " + responseTopologyGroups400_description);
} else {
- $("#examples-Schemas-getSchemas-title-400").text("Status: 400 - " + responseSchemas400_description.substring(0, responseSchemas400_description_break));
- $("#examples-Schemas-getSchemas-description-400").html(responseSchemas400_description.substring(responseSchemas400_description_break));
+ $("#examples-TopologyGroups-updateGroup-title-400").text("Status: 400 - " + responseTopologyGroups400_description.substring(0, responseTopologyGroups400_description_break));
+ $("#examples-TopologyGroups-updateGroup-description-400").html(responseTopologyGroups400_description.substring(responseTopologyGroups400_description_break));
}
</script>
- <ul id="responses-detail-Schemas-getSchemas-400" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-TopologyGroups-updateGroup-400" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-getSchemas-400-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-TopologyGroups-updateGroup-400-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-getSchemas-400-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-getSchemas-400-schema">
- <div id="responses-Schemas-getSchemas-schema-400" class="exampleStyle">
+ <div class="tab-content" id="responses-TopologyGroups-updateGroup-400-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-TopologyGroups-updateGroup-400-schema">
+ <div id="responses-TopologyGroups-updateGroup-schema-400" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-getSchemas-400-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-getSchemas-schema-400');
+ $('#responses-TopologyGroups-updateGroup-400-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-TopologyGroups-updateGroup-schema-400');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-getSchemas-400-schema-data' type='hidden' value=''></input>
+ <input id='responses-TopologyGroups-updateGroup-400-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-getSchemas-title-401"></h3>
- <p id="examples-Schemas-getSchemas-description-401" class="marked"></p>
+ <h3 id="examples-TopologyGroups-updateGroup-title-401"></h3>
+ <p id="examples-TopologyGroups-updateGroup-description-401" class="marked"></p>
<script>
- var responseSchemas401_description = `Unauthorized`;
- var responseSchemas401_description_break = responseSchemas401_description.indexOf('\n');
- if (responseSchemas401_description_break == -1) {
- $("#examples-Schemas-getSchemas-title-401").text("Status: 401 - " + responseSchemas401_description);
+ var responseTopologyGroups401_description = `Unauthorized`;
+ var responseTopologyGroups401_description_break = responseTopologyGroups401_description.indexOf('\n');
+ if (responseTopologyGroups401_description_break == -1) {
+ $("#examples-TopologyGroups-updateGroup-title-401").text("Status: 401 - " + responseTopologyGroups401_description);
} else {
- $("#examples-Schemas-getSchemas-title-401").text("Status: 401 - " + responseSchemas401_description.substring(0, responseSchemas401_description_break));
- $("#examples-Schemas-getSchemas-description-401").html(responseSchemas401_description.substring(responseSchemas401_description_break));
+ $("#examples-TopologyGroups-updateGroup-title-401").text("Status: 401 - " + responseTopologyGroups401_description.substring(0, responseTopologyGroups401_description_break));
+ $("#examples-TopologyGroups-updateGroup-description-401").html(responseTopologyGroups401_description.substring(responseTopologyGroups401_description_break));
}
</script>
- <ul id="responses-detail-Schemas-getSchemas-401" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-TopologyGroups-updateGroup-401" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-getSchemas-401-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-TopologyGroups-updateGroup-401-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-getSchemas-401-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-getSchemas-401-schema">
- <div id="responses-Schemas-getSchemas-schema-401" class="exampleStyle">
+ <div class="tab-content" id="responses-TopologyGroups-updateGroup-401-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-TopologyGroups-updateGroup-401-schema">
+ <div id="responses-TopologyGroups-updateGroup-schema-401" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-getSchemas-401-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-getSchemas-schema-401');
+ $('#responses-TopologyGroups-updateGroup-401-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-TopologyGroups-updateGroup-schema-401');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-getSchemas-401-schema-data' type='hidden' value=''></input>
+ <input id='responses-TopologyGroups-updateGroup-401-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-getSchemas-title-403"></h3>
- <p id="examples-Schemas-getSchemas-description-403" class="marked"></p>
+ <h3 id="examples-TopologyGroups-updateGroup-title-403"></h3>
+ <p id="examples-TopologyGroups-updateGroup-description-403" class="marked"></p>
<script>
- var responseSchemas403_description = `Forbidden`;
- var responseSchemas403_description_break = responseSchemas403_description.indexOf('\n');
- if (responseSchemas403_description_break == -1) {
- $("#examples-Schemas-getSchemas-title-403").text("Status: 403 - " + responseSchemas403_description);
+ var responseTopologyGroups403_description = `Forbidden`;
+ var responseTopologyGroups403_description_break = responseTopologyGroups403_description.indexOf('\n');
+ if (responseTopologyGroups403_description_break == -1) {
+ $("#examples-TopologyGroups-updateGroup-title-403").text("Status: 403 - " + responseTopologyGroups403_description);
} else {
- $("#examples-Schemas-getSchemas-title-403").text("Status: 403 - " + responseSchemas403_description.substring(0, responseSchemas403_description_break));
- $("#examples-Schemas-getSchemas-description-403").html(responseSchemas403_description.substring(responseSchemas403_description_break));
+ $("#examples-TopologyGroups-updateGroup-title-403").text("Status: 403 - " + responseTopologyGroups403_description.substring(0, responseTopologyGroups403_description_break));
+ $("#examples-TopologyGroups-updateGroup-description-403").html(responseTopologyGroups403_description.substring(responseTopologyGroups403_description_break));
}
</script>
- <ul id="responses-detail-Schemas-getSchemas-403" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-TopologyGroups-updateGroup-403" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-getSchemas-403-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-TopologyGroups-updateGroup-403-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-getSchemas-403-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-getSchemas-403-schema">
- <div id="responses-Schemas-getSchemas-schema-403" class="exampleStyle">
+ <div class="tab-content" id="responses-TopologyGroups-updateGroup-403-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-TopologyGroups-updateGroup-403-schema">
+ <div id="responses-TopologyGroups-updateGroup-schema-403" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-getSchemas-403-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-getSchemas-schema-403');
+ $('#responses-TopologyGroups-updateGroup-403-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-TopologyGroups-updateGroup-schema-403');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-getSchemas-403-schema-data' type='hidden' value=''></input>
+ <input id='responses-TopologyGroups-updateGroup-403-schema-data' type='hidden' value=''></input>
</div>
</div>
- <h3 id="examples-Schemas-getSchemas-title-500"></h3>
- <p id="examples-Schemas-getSchemas-description-500" class="marked"></p>
+ <h3 id="examples-TopologyGroups-updateGroup-title-409"></h3>
+ <p id="examples-TopologyGroups-updateGroup-description-409" class="marked"></p>
<script>
- var responseSchemas500_description = `Internal Server Error`;
- var responseSchemas500_description_break = responseSchemas500_description.indexOf('\n');
- if (responseSchemas500_description_break == -1) {
- $("#examples-Schemas-getSchemas-title-500").text("Status: 500 - " + responseSchemas500_description);
+ var responseTopologyGroups409_description = `Conflict`;
+ var responseTopologyGroups409_description_break = responseTopologyGroups409_description.indexOf('\n');
+ if (responseTopologyGroups409_description_break == -1) {
+ $("#examples-TopologyGroups-updateGroup-title-409").text("Status: 409 - " + responseTopologyGroups409_description);
} else {
- $("#examples-Schemas-getSchemas-title-500").text("Status: 500 - " + responseSchemas500_description.substring(0, responseSchemas500_description_break));
- $("#examples-Schemas-getSchemas-description-500").html(responseSchemas500_description.substring(responseSchemas500_description_break));
+ $("#examples-TopologyGroups-updateGroup-title-409").text("Status: 409 - " + responseTopologyGroups409_description.substring(0, responseTopologyGroups409_description_break));
+ $("#examples-TopologyGroups-updateGroup-description-409").html(responseTopologyGroups409_description.substring(responseTopologyGroups409_description_break));
}
</script>
- <ul id="responses-detail-Schemas-getSchemas-500" class="nav nav-tabs nav-tabs-examples" >
+ <ul id="responses-detail-TopologyGroups-updateGroup-409" class="nav nav-tabs nav-tabs-examples" >
<li class="active">
- <a data-toggle="tab" href="#responses-Schemas-getSchemas-500-schema">Schema</a>
+ <a data-toggle="tab" href="#responses-TopologyGroups-updateGroup-409-schema">Schema</a>
</li>
</ul>
- <div class="tab-content" id="responses-Schemas-getSchemas-500-wrapper" style='margin-bottom: 10px;'>
- <div class="tab-pane active" id="responses-Schemas-getSchemas-500-schema">
- <div id="responses-Schemas-getSchemas-schema-500" class="exampleStyle">
+ <div class="tab-content" id="responses-TopologyGroups-updateGroup-409-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-TopologyGroups-updateGroup-409-schema">
+ <div id="responses-TopologyGroups-updateGroup-schema-409" class="exampleStyle">
+ <script>
+ $(document).ready(function() {
+ var schemaWrapper = {
+ "description" : "Conflict",
+ "content" : {
+ "application/problem+json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ErrorMessage"
+ },
+ "example" : {
+ "status" : "409",
+ "title" : "Conflicting request",
+ "details" : "The request cannot be processed as the resource is in use."
+ }
+ }
+ }
+};
+ var schema = findNode('schema',schemaWrapper).schema;
+ if (!schema) {
+ schema = schemaWrapper.schema;
+ }
+ if (schema == null) {
+ return;
+ }
+ if (schema.$ref != null) {
+ schema = defsParser.$refs.get(schema.$ref);
+ if (schema.properties != null) {
+ Object.keys(schema.properties).forEach( (item) => {
+ if (schema.properties[item].$ref != null) {
+ schema.properties[item] = defsParser.$refs.get(schema.properties[item].$ref);
+ }
+ });
+ }
+ } else if (schema.items != null && schema.items.$ref != null) {
+ schema.items = defsParser.$refs.get(schema.items.$ref);
+ } else {
+ schemaWrapper.definitions = Object.assign({}, defs);
+ $RefParser.dereference(schemaWrapper).catch(function(err) {
+ console.log(err);
+ });
+ }
+
+ var view = new JSONSchemaView(schema, 3);
+ $('#responses-TopologyGroups-updateGroup-409-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-TopologyGroups-updateGroup-schema-409');
+ result.empty();
+ result.append(view.render());
+ });
+ </script>
+ </div>
+ <input id='responses-TopologyGroups-updateGroup-409-schema-data' type='hidden' value=''></input>
+ </div>
+ </div>
+ <h3 id="examples-TopologyGroups-updateGroup-title-500"></h3>
+ <p id="examples-TopologyGroups-updateGroup-description-500" class="marked"></p>
+ <script>
+ var responseTopologyGroups500_description = `Internal Server Error`;
+ var responseTopologyGroups500_description_break = responseTopologyGroups500_description.indexOf('\n');
+ if (responseTopologyGroups500_description_break == -1) {
+ $("#examples-TopologyGroups-updateGroup-title-500").text("Status: 500 - " + responseTopologyGroups500_description);
+ } else {
+ $("#examples-TopologyGroups-updateGroup-title-500").text("Status: 500 - " + responseTopologyGroups500_description.substring(0, responseTopologyGroups500_description_break));
+ $("#examples-TopologyGroups-updateGroup-description-500").html(responseTopologyGroups500_description.substring(responseTopologyGroups500_description_break));
+ }
+ </script>
+
+
+ <ul id="responses-detail-TopologyGroups-updateGroup-500" class="nav nav-tabs nav-tabs-examples" >
+ <li class="active">
+ <a data-toggle="tab" href="#responses-TopologyGroups-updateGroup-500-schema">Schema</a>
+ </li>
+
+
+
+
+ </ul>
+
+
+ <div class="tab-content" id="responses-TopologyGroups-updateGroup-500-wrapper" style='margin-bottom: 10px;'>
+ <div class="tab-pane active" id="responses-TopologyGroups-updateGroup-500-schema">
+ <div id="responses-TopologyGroups-updateGroup-schema-500" class="exampleStyle">
<script>
$(document).ready(function() {
var schemaWrapper = {
}
var view = new JSONSchemaView(schema, 3);
- $('#responses-Schemas-getSchemas-500-schema-data').val(JSON.stringify(schema));
- var result = $('#responses-Schemas-getSchemas-schema-500');
+ $('#responses-TopologyGroups-updateGroup-500-schema-data').val(JSON.stringify(schema));
+ var result = $('#responses-TopologyGroups-updateGroup-schema-500');
result.empty();
result.append(view.render());
});
</script>
</div>
- <input id='responses-Schemas-getSchemas-500-schema-data' type='hidden' value=''></input>
+ <input id='responses-TopologyGroups-updateGroup-500-schema-data' type='hidden' value=''></input>
</div>
</div>
</article>
Code Review / smo / teiv.git / commitdiff