Gitiles
Code Review Sign In
gerrit.nordix.org / oransc / smo / teiv / 669c6484153c45ba67e95a410af338888ec2a435 / . / docs / offeredapis / index.html
blob: 831b217df5fc650c6a8168c7fbb3f306d21e3ff1 [file] [log] [blame]
JohnKeeney669c6482024-07-09 18:49:32 +0100[diff] [blame^]1<!doctype html>
2<html>
3 <head>
4 <title>Topology and Inventory API</title>
5 <style type="text/css">
6 body {
7 font-family: Trebuchet MS, sans-serif;
8 font-size: 15px;
9 color: #444;
10 margin-right: 24px;
11}
12
13h1 {
14 font-size: 25px;
15}
16h2 {
17 font-size: 20px;
18}
19h3 {
20 font-size: 16px;
21 font-weight: bold;
22}
23hr {
24 height: 1px;
25 border: 0;
26 color: #ddd;
27 background-color: #ddd;
28}
29
30.app-desc {
31 clear: both;
32 margin-left: 20px;
33}
34.param-name {
35 width: 100%;
36}
37.license-info {
38 margin-left: 20px;
39}
40
41.license-url {
42 margin-left: 20px;
43}
44
45.model {
46 margin: 0 0 0px 20px;
47}
48
49.method {
50 margin-left: 20px;
51}
52
53.method-notes {
54 margin: 10px 0 20px 0;
55 font-size: 90%;
56 color: #555;
57}
58
59pre {
60 padding: 10px;
61 margin-bottom: 2px;
62}
63
64.http-method {
65 text-transform: uppercase;
66}
67
68pre.get {
69 background-color: #0f6ab4;
70}
71
72pre.post {
73 background-color: #10a54a;
74}
75
76pre.put {
77 background-color: #c5862b;
78}
79
80pre.delete {
81 background-color: #a41e22;
82}
83
84.huge {
85 color: #fff;
86}
87
88pre.example {
89 background-color: #f3f3f3;
90 padding: 10px;
91 border: 1px solid #ddd;
92}
93
94code {
95 white-space: pre;
96}
97
98.nickname {
99 font-weight: bold;
100}
101
102.method-path {
103 font-size: 1.5em;
104 background-color: #0f6ab4;
105}
106
107.up {
108 float:right;
109}
110
111.parameter {
112 width: 500px;
113}
114
115.param {
116 width: 500px;
117 padding: 10px 0 0 20px;
118 font-weight: bold;
119}
120
121.param-desc {
122 width: 700px;
123 padding: 0 0 0 20px;
124 color: #777;
125}
126
127.param-type {
128 font-style: italic;
129}
130
131.param-enum-header {
132width: 700px;
133padding: 0 0 0 60px;
134color: #777;
135font-weight: bold;
136}
137
138.param-enum {
139width: 700px;
140padding: 0 0 0 80px;
141color: #777;
142font-style: italic;
143}
144
145.field-label {
146 padding: 0;
147 margin: 0;
148 clear: both;
149}
150
151.field-items {
152 padding: 0 0 15px 0;
153 margin-bottom: 15px;
154}
155
156.return-type {
157 clear: both;
158 padding-bottom: 10px;
159}
160
161.param-header {
162 font-weight: bold;
163}
164
165.method-tags {
166 text-align: right;
167}
168
169.method-tag {
170 background: none repeat scroll 0% 0% #24A600;
171 border-radius: 3px;
172 padding: 2px 10px;
173 margin: 2px;
174 color: #FFF;
175 display: inline-block;
176 text-decoration: none;
177}
178
179 </style>
180 </head>
181 <body>
182 <h1>Topology and Inventory API</h1>
183 <div 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>
184<p>Topology and Inventory supports several topology domains. A domain is a grouping of network topology entities which handles topology data.</p>
185<p>Entities are enabling the modelling and storage of complex network infrastructure and relationships.</p>
186<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>
187<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>
188<h2>Querying simple entities</h2>
189<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>
190<p>| USE CASE | ENTITY TYPE | TARGET FILTER | SCOPE FILTER | QUERY RESULT |
191|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------|:----------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------|
192| To return the ids for all instances of the entityType used in the query. |  GNBDUFunction | | | All ids of every GNBDUFunction |
193| To return all attributes of every instance of the entityType used in the query. |  GNBDUFunction |  /attributes | | All GNBDUFunctions with every attribute |
194| 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 |
195| 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 &quot;,&quot; in case of using parenthesis &quot;()&quot;. <br/> Case 2: The attributes must be separated by a semicolon &quot;;&quot; in case of using slash &quot;/&quot;. <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 |
196| 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, &quot;/SubNetwork=Ireland/&quot;)] | Unique set of ids of GNBDUFunctions, where fdn contains &quot;SubNetwork=Ireland&quot; |
197| 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 &quot;,&quot;. |  GNBDUFunction | | /attributes[@gNBIdLength=3 and @gNBId=111] | Unique set of ids of GNBDUFunctions, where the gNBIdLength equals 3 and the gNBId equals 111 |
198| 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>
199<h2>Querying connected entities</h2>
200<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>
201<p>| USE CASE | ENTITY TYPE | TARGET FILTER | SCOPE FILTER | QUERY RESULT |
202|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|-------------------------------------|-----------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|
203| 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 |
204| 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 |
205| 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 |
206| 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>
207</div>
208 <div class="app-desc">More information: <a href="https://openapi-generator.tech">https://openapi-generator.tech</a></div>
209 <div class="app-desc">Contact Info: <a href="team@openapitools.org">team@openapitools.org</a></div>
210 <div class="app-desc">Version: 0.11.0</div>
211 <div class="app-desc">BasePath:/topology-inventory/v1alpha11</div>
212 <div class="license-info">Copyright (C) 2024 Ericsson, Modifications Copyright (C) 2024 OpenInfra Foundation Europe. All rights reserved.</div>
213 <div class="license-url">http://www.apache.org/licenses/LICENSE-2.0</div>
214 <h2>Access</h2>
215
216 <h2><a name="__Methods">Methods</a></h2>
217 [ Jump to <a href="#__Models">Models</a> ]
218
219 <h3>Table of Contents </h3>
220 <div class="method-summary"></div>
221 <h4><a href="#Classifiers">Classifiers</a></h4>
222 <ul>
223 <li><a href="#updateClassifier"><code><span class="http-method">put</span> /classifiers</code></a></li>
224 </ul>
225 <h4><a href="#Collections">Collections</a></h4>
226 <ul>
227 <li><a href="#createCollection"><code><span class="http-method">post</span> /collections</code></a></li>
228 <li><a href="#deleteCollection"><code><span class="http-method">delete</span> /collections/{collectionId}</code></a></li>
229 <li><a href="#getAllCollections"><code><span class="http-method">get</span> /collections</code></a></li>
230 <li><a href="#getCollection"><code><span class="http-method">get</span> /collections/{collectionId}</code></a></li>
231 <li><a href="#updateCollection"><code><span class="http-method">put</span> /collections/{collectionId}</code></a></li>
232 </ul>
233 <h4><a href="#Decorators">Decorators</a></h4>
234 <ul>
235 <li><a href="#updateDecorator"><code><span class="http-method">put</span> /decorators</code></a></li>
236 </ul>
237 <h4><a href="#EntitiesAndRelationships">EntitiesAndRelationships</a></h4>
238 <ul>
239 <li><a href="#getAllDomains"><code><span class="http-method">get</span> /domains</code></a></li>
240 <li><a href="#getAllRelationshipsForEntityId"><code><span class="http-method">get</span> /domains/{domainName}/entity-types/{entityTypeName}/entities/{entityId}/relationships</code></a></li>
241 <li><a href="#getEntitiesByDomain"><code><span class="http-method">get</span> /domains/{domainName}/entities</code></a></li>
242 <li><a href="#getRelationshipById"><code><span class="http-method">get</span> /domains/{domainName}/relationship-types/{relationshipTypeName}/relationships/{relationshipId}</code></a></li>
243 <li><a href="#getRelationshipsByType"><code><span class="http-method">get</span> /domains/{domainName}/relationship-types/{relationshipTypeName}/relationships</code></a></li>
244 <li><a href="#getTopologyByEntityTypeName"><code><span class="http-method">get</span> /domains/{domainName}/entity-types/{entityTypeName}/entities</code></a></li>
245 <li><a href="#getTopologyById"><code><span class="http-method">get</span> /domains/{domainName}/entity-types/{entityTypeName}/entities/{entityId}</code></a></li>
246 <li><a href="#getTopologyEntityTypes"><code><span class="http-method">get</span> /domains/{domainName}/entity-types</code></a></li>
247 <li><a href="#getTopologyRelationshipTypes"><code><span class="http-method">get</span> /domains/{domainName}/relationship-types</code></a></li>
248 </ul>
249 <h4><a href="#GeoQuery">GeoQuery</a></h4>
250 <ul>
251 <li><a href="#geoQueryTopologyAcrossDomains"><code><span class="http-method">post</span> /geo-queries</code></a></li>
252 </ul>
253 <h4><a href="#Schemas">Schemas</a></h4>
254 <ul>
255 <li><a href="#createSchema"><code><span class="http-method">post</span> /schemas</code></a></li>
256 <li><a href="#deleteSchema"><code><span class="http-method">delete</span> /schemas/{schemaName}</code></a></li>
257 <li><a href="#getSchemaByName"><code><span class="http-method">get</span> /schemas/{schemaName}/content</code></a></li>
258 <li><a href="#getSchemas"><code><span class="http-method">get</span> /schemas</code></a></li>
259 </ul>
260
261 <h1><a name="Classifiers">Classifiers</a></h1>
262 <div class="method"><a name="updateClassifier"/>
263 <div class="method-path">
264 <a class="up" href="#__Methods">Up</a>
265 <pre class="put"><code class="huge"><span class="http-method">put</span> /classifiers</code></pre></div>
266 <div class="method-summary">Update entities and/or relationships with classifier(s). (<span class="nickname">updateClassifier</span>)</div>
267 <div class="method-notes">Update entities and/or relationships with classifier(s).</div>
268
269
270 <h3 class="field-label">Consumes</h3>
271 This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
272 <ul>
273 <li><code>application/json</code></li>
274 </ul>
275
276 <h3 class="field-label">Request body</h3>
277 <div class="field-items">
278 <div class="param">Classifier <a href="#Classifier">Classifier</a> (required)</div>
279
280 <div class="param-desc"><span class="param-type">Body Parameter</span> &mdash; </div>
281
282 </div> <!-- field-items -->
283
284 <h3 class="field-label">Request headers</h3>
285 <div class="field-items">
286 <div class="param">Accept (required)</div>
287
288 <div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: application/json </div>
289<div class="param">Content-Type (required)</div>
290
291 <div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: application/json </div>
292
293 </div> <!-- field-items -->
294
295
296
297
298 <!--Todo: process Response Object and its headers, schema, examples -->
299
300 <h3 class="field-label">Example data</h3>
301 <div class="example-data-content-type">Content-Type: application/problem+json</div>
302 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
303 <h3 class="field-label">Example data</h3>
304 <div class="example-data-content-type">Content-Type: application/problem+json</div>
305 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
306 <h3 class="field-label">Example data</h3>
307 <div class="example-data-content-type">Content-Type: application/problem+json</div>
308 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
309 <h3 class="field-label">Example data</h3>
310 <div class="example-data-content-type">Content-Type: application/problem+json</div>
311 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
312 <h3 class="field-label">Example data</h3>
313 <div class="example-data-content-type">Content-Type: application/problem+json</div>
314 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
315
316 <h3 class="field-label">Produces</h3>
317 This API call produces the following media types according to the <span class="header">Accept</span> request header;
318 the media type will be conveyed by the <span class="header">Content-Type</span> response header.
319 <ul>
320 <li><code>application/problem+json</code></li>
321 </ul>
322
323 <h3 class="field-label">Responses</h3>
324 <h4 class="field-label">204</h4>
325 No Content
326 <a href="#"></a>
327 <h4 class="field-label">400</h4>
328 Bad Request
329 <a href="#ErrorMessage">ErrorMessage</a>
330 <h4 class="field-label">401</h4>
331 Unauthorized
332 <a href="#ErrorMessage">ErrorMessage</a>
333 <h4 class="field-label">403</h4>
334 Forbidden
335 <a href="#ErrorMessage">ErrorMessage</a>
336 <h4 class="field-label">409</h4>
337 Conflict
338 <a href="#ErrorMessage">ErrorMessage</a>
339 <h4 class="field-label">500</h4>
340 Internal Server Error
341 <a href="#ErrorMessage">ErrorMessage</a>
342 </div> <!-- method -->
343 <hr/>
344 <h1><a name="Collections">Collections</a></h1>
345 <div class="method"><a name="createCollection"/>
346 <div class="method-path">
347 <a class="up" href="#__Methods">Up</a>
348 <pre class="post"><code class="huge"><span class="http-method">post</span> /collections</code></pre></div>
349 <div class="method-summary">Create a collection. (<span class="nickname">createCollection</span>)</div>
350 <div class="method-notes">Create a collection.</div>
351
352
353 <h3 class="field-label">Consumes</h3>
354 This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
355 <ul>
356 <li><code>application/json</code></li>
357 </ul>
358
359 <h3 class="field-label">Request body</h3>
360 <div class="field-items">
361 <div class="param">Collection <a href="#Collection">Collection</a> (required)</div>
362
363 <div class="param-desc"><span class="param-type">Body Parameter</span> &mdash; </div>
364
365 </div> <!-- field-items -->
366
367 <h3 class="field-label">Request headers</h3>
368 <div class="field-items">
369 <div class="param">Accept (required)</div>
370
371 <div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: application/json </div>
372<div class="param">Content-Type (required)</div>
373
374 <div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: application/json </div>
375
376 </div> <!-- field-items -->
377
378
379
380 <h3 class="field-label">Return type</h3>
381 <div class="return-type">
382 <a href="#CollectionResponse">CollectionResponse</a>
383
384 </div>
385
386 <!--Todo: process Response Object and its headers, schema, examples -->
387
388 <h3 class="field-label">Example data</h3>
389 <div class="example-data-content-type">Content-Type: application/json</div>
390 <pre class="example"><code>{
391 "criteria" : {
392 "resourceInstances" : [ "resourceInstances", "resourceInstances" ]
393 },
394 "id" : "id",
395 "collectionName" : "collectionName"
396}</code></pre>
397 <h3 class="field-label">Example data</h3>
398 <div class="example-data-content-type">Content-Type: application/problem+json</div>
399 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
400 <h3 class="field-label">Example data</h3>
401 <div class="example-data-content-type">Content-Type: application/problem+json</div>
402 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
403 <h3 class="field-label">Example data</h3>
404 <div class="example-data-content-type">Content-Type: application/problem+json</div>
405 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
406 <h3 class="field-label">Example data</h3>
407 <div class="example-data-content-type">Content-Type: application/problem+json</div>
408 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
409 <h3 class="field-label">Example data</h3>
410 <div class="example-data-content-type">Content-Type: application/problem+json</div>
411 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
412
413 <h3 class="field-label">Produces</h3>
414 This API call produces the following media types according to the <span class="header">Accept</span> request header;
415 the media type will be conveyed by the <span class="header">Content-Type</span> response header.
416 <ul>
417 <li><code>application/json</code></li>
418 <li><code>application/problem+json</code></li>
419 </ul>
420
421 <h3 class="field-label">Responses</h3>
422 <h4 class="field-label">201</h4>
423 Created
424 <a href="#CollectionResponse">CollectionResponse</a>
425 <h4 class="field-label">400</h4>
426 Bad Request
427 <a href="#ErrorMessage">ErrorMessage</a>
428 <h4 class="field-label">401</h4>
429 Unauthorized
430 <a href="#ErrorMessage">ErrorMessage</a>
431 <h4 class="field-label">403</h4>
432 Forbidden
433 <a href="#ErrorMessage">ErrorMessage</a>
434 <h4 class="field-label">409</h4>
435 Conflict
436 <a href="#ErrorMessage">ErrorMessage</a>
437 <h4 class="field-label">500</h4>
438 Internal Server Error
439 <a href="#ErrorMessage">ErrorMessage</a>
440 </div> <!-- method -->
441 <hr/>
442 <div class="method"><a name="deleteCollection"/>
443 <div class="method-path">
444 <a class="up" href="#__Methods">Up</a>
445 <pre class="delete"><code class="huge"><span class="http-method">delete</span> /collections/{collectionId}</code></pre></div>
446 <div class="method-summary">Delete a collection with specified id. (<span class="nickname">deleteCollection</span>)</div>
447 <div class="method-notes">Delete a collection with specified id.</div>
448
449 <h3 class="field-label">Path parameters</h3>
450 <div class="field-items">
451 <div class="param">collectionId (required)</div>
452
453 <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; default: null </div>
454 </div> <!-- field-items -->
455
456
457
458 <h3 class="field-label">Request headers</h3>
459 <div class="field-items">
460 <div class="param">Accept (required)</div>
461
462 <div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: application/json </div>
463
464 </div> <!-- field-items -->
465
466
467
468
469 <!--Todo: process Response Object and its headers, schema, examples -->
470
471 <h3 class="field-label">Example data</h3>
472 <div class="example-data-content-type">Content-Type: application/problem+json</div>
473 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
474 <h3 class="field-label">Example data</h3>
475 <div class="example-data-content-type">Content-Type: application/problem+json</div>
476 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
477 <h3 class="field-label">Example data</h3>
478 <div class="example-data-content-type">Content-Type: application/problem+json</div>
479 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
480 <h3 class="field-label">Example data</h3>
481 <div class="example-data-content-type">Content-Type: application/problem+json</div>
482 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
483 <h3 class="field-label">Example data</h3>
484 <div class="example-data-content-type">Content-Type: application/problem+json</div>
485 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
486
487 <h3 class="field-label">Produces</h3>
488 This API call produces the following media types according to the <span class="header">Accept</span> request header;
489 the media type will be conveyed by the <span class="header">Content-Type</span> response header.
490 <ul>
491 <li><code>application/problem+json</code></li>
492 </ul>
493
494 <h3 class="field-label">Responses</h3>
495 <h4 class="field-label">204</h4>
496 No Content
497 <a href="#"></a>
498 <h4 class="field-label">400</h4>
499 Bad Request
500 <a href="#ErrorMessage">ErrorMessage</a>
501 <h4 class="field-label">401</h4>
502 Unauthorized
503 <a href="#ErrorMessage">ErrorMessage</a>
504 <h4 class="field-label">403</h4>
505 Forbidden
506 <a href="#ErrorMessage">ErrorMessage</a>
507 <h4 class="field-label">404</h4>
508 Not Found
509 <a href="#ErrorMessage">ErrorMessage</a>
510 <h4 class="field-label">500</h4>
511 Internal Server Error
512 <a href="#ErrorMessage">ErrorMessage</a>
513 </div> <!-- method -->
514 <hr/>
515 <div class="method"><a name="getAllCollections"/>
516 <div class="method-path">
517 <a class="up" href="#__Methods">Up</a>
518 <pre class="get"><code class="huge"><span class="http-method">get</span> /collections</code></pre></div>
519 <div class="method-summary">Get all collections. (<span class="nickname">getAllCollections</span>)</div>
520 <div class="method-notes">Get all collections.</div>
521
522
523
524
525 <h3 class="field-label">Request headers</h3>
526 <div class="field-items">
527 <div class="param">Accept (required)</div>
528
529 <div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: application/json </div>
530
531 </div> <!-- field-items -->
532
533 <h3 class="field-label">Query parameters</h3>
534 <div class="field-items">
535 <div class="param">offset (optional)</div>
536
537 <div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Pagination offset. default: 0 </div><div class="param">limit (optional)</div>
538
539 <div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Result limiter. default: 500 </div>
540 </div> <!-- field-items -->
541
542
543 <h3 class="field-label">Return type</h3>
544 <div class="return-type">
545 <a href="#Collections">Collections</a>
546
547 </div>
548
549 <!--Todo: process Response Object and its headers, schema, examples -->
550
551 <h3 class="field-label">Example data</h3>
552 <div class="example-data-content-type">Content-Type: application/json</div>
553 <pre class="example"><code>{
554 "next" : {
555 "href" : "href"
556 },
557 "last" : {
558 "href" : "href"
559 },
560 "prev" : {
561 "href" : "href"
562 },
563 "self" : {
564 "href" : "href"
565 },
566 "totalCount" : 0,
567 "items" : [ {
568 "criteria" : {
569 "resourceInstances" : [ "resourceInstances", "resourceInstances" ]
570 },
571 "id" : "id",
572 "collectionName" : "collectionName"
573 }, {
574 "criteria" : {
575 "resourceInstances" : [ "resourceInstances", "resourceInstances" ]
576 },
577 "id" : "id",
578 "collectionName" : "collectionName"
579 } ],
580 "first" : {
581 "href" : "href"
582 }
583}</code></pre>
584 <h3 class="field-label">Example data</h3>
585 <div class="example-data-content-type">Content-Type: application/problem+json</div>
586 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
587 <h3 class="field-label">Example data</h3>
588 <div class="example-data-content-type">Content-Type: application/problem+json</div>
589 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
590 <h3 class="field-label">Example data</h3>
591 <div class="example-data-content-type">Content-Type: application/problem+json</div>
592 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
593 <h3 class="field-label">Example data</h3>
594 <div class="example-data-content-type">Content-Type: application/problem+json</div>
595 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
596
597 <h3 class="field-label">Produces</h3>
598 This API call produces the following media types according to the <span class="header">Accept</span> request header;
599 the media type will be conveyed by the <span class="header">Content-Type</span> response header.
600 <ul>
601 <li><code>application/json</code></li>
602 <li><code>application/problem+json</code></li>
603 </ul>
604
605 <h3 class="field-label">Responses</h3>
606 <h4 class="field-label">200</h4>
607 OK
608 <a href="#Collections">Collections</a>
609 <h4 class="field-label">204</h4>
610 No Content
611 <a href="#"></a>
612 <h4 class="field-label">400</h4>
613 Bad Request
614 <a href="#ErrorMessage">ErrorMessage</a>
615 <h4 class="field-label">401</h4>
616 Unauthorized
617 <a href="#ErrorMessage">ErrorMessage</a>
618 <h4 class="field-label">403</h4>
619 Forbidden
620 <a href="#ErrorMessage">ErrorMessage</a>
621 <h4 class="field-label">500</h4>
622 Internal Server Error
623 <a href="#ErrorMessage">ErrorMessage</a>
624 </div> <!-- method -->
625 <hr/>
626 <div class="method"><a name="getCollection"/>
627 <div class="method-path">
628 <a class="up" href="#__Methods">Up</a>
629 <pre class="get"><code class="huge"><span class="http-method">get</span> /collections/{collectionId}</code></pre></div>
630 <div class="method-summary">Get a collection with specified id. (<span class="nickname">getCollection</span>)</div>
631 <div class="method-notes">Get a collection with specified id.</div>
632
633 <h3 class="field-label">Path parameters</h3>
634 <div class="field-items">
635 <div class="param">collectionId (required)</div>
636
637 <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; default: null </div>
638 </div> <!-- field-items -->
639
640
641
642 <h3 class="field-label">Request headers</h3>
643 <div class="field-items">
644 <div class="param">Accept (required)</div>
645
646 <div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: application/json </div>
647
648 </div> <!-- field-items -->
649
650
651
652 <h3 class="field-label">Return type</h3>
653 <div class="return-type">
654 <a href="#CollectionResponse">CollectionResponse</a>
655
656 </div>
657
658 <!--Todo: process Response Object and its headers, schema, examples -->
659
660 <h3 class="field-label">Example data</h3>
661 <div class="example-data-content-type">Content-Type: application/json</div>
662 <pre class="example"><code>{
663 "criteria" : {
664 "resourceInstances" : [ "resourceInstances", "resourceInstances" ]
665 },
666 "id" : "id",
667 "collectionName" : "collectionName"
668}</code></pre>
669 <h3 class="field-label">Example data</h3>
670 <div class="example-data-content-type">Content-Type: application/problem+json</div>
671 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
672 <h3 class="field-label">Example data</h3>
673 <div class="example-data-content-type">Content-Type: application/problem+json</div>
674 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
675 <h3 class="field-label">Example data</h3>
676 <div class="example-data-content-type">Content-Type: application/problem+json</div>
677 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
678 <h3 class="field-label">Example data</h3>
679 <div class="example-data-content-type">Content-Type: application/problem+json</div>
680 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
681 <h3 class="field-label">Example data</h3>
682 <div class="example-data-content-type">Content-Type: application/problem+json</div>
683 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
684
685 <h3 class="field-label">Produces</h3>
686 This API call produces the following media types according to the <span class="header">Accept</span> request header;
687 the media type will be conveyed by the <span class="header">Content-Type</span> response header.
688 <ul>
689 <li><code>application/json</code></li>
690 <li><code>application/problem+json</code></li>
691 </ul>
692
693 <h3 class="field-label">Responses</h3>
694 <h4 class="field-label">200</h4>
695 OK
696 <a href="#CollectionResponse">CollectionResponse</a>
697 <h4 class="field-label">400</h4>
698 Bad Request
699 <a href="#ErrorMessage">ErrorMessage</a>
700 <h4 class="field-label">401</h4>
701 Unauthorized
702 <a href="#ErrorMessage">ErrorMessage</a>
703 <h4 class="field-label">403</h4>
704 Forbidden
705 <a href="#ErrorMessage">ErrorMessage</a>
706 <h4 class="field-label">404</h4>
707 Not Found
708 <a href="#ErrorMessage">ErrorMessage</a>
709 <h4 class="field-label">500</h4>
710 Internal Server Error
711 <a href="#ErrorMessage">ErrorMessage</a>
712 </div> <!-- method -->
713 <hr/>
714 <div class="method"><a name="updateCollection"/>
715 <div class="method-path">
716 <a class="up" href="#__Methods">Up</a>
717 <pre class="put"><code class="huge"><span class="http-method">put</span> /collections/{collectionId}</code></pre></div>
718 <div class="method-summary">Update a collection. (<span class="nickname">updateCollection</span>)</div>
719 <div class="method-notes">Update a collection.</div>
720
721 <h3 class="field-label">Path parameters</h3>
722 <div class="field-items">
723 <div class="param">collectionId (required)</div>
724
725 <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; default: null </div>
726 </div> <!-- field-items -->
727
728 <h3 class="field-label">Consumes</h3>
729 This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
730 <ul>
731 <li><code>application/json</code></li>
732 </ul>
733
734 <h3 class="field-label">Request body</h3>
735 <div class="field-items">
736 <div class="param">Collection <a href="#Collection">Collection</a> (required)</div>
737
738 <div class="param-desc"><span class="param-type">Body Parameter</span> &mdash; </div>
739
740 </div> <!-- field-items -->
741
742 <h3 class="field-label">Request headers</h3>
743 <div class="field-items">
744 <div class="param">Accept (required)</div>
745
746 <div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: application/json </div>
747<div class="param">Content-Type (required)</div>
748
749 <div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: application/json </div>
750
751 </div> <!-- field-items -->
752
753
754
755
756 <!--Todo: process Response Object and its headers, schema, examples -->
757
758 <h3 class="field-label">Example data</h3>
759 <div class="example-data-content-type">Content-Type: application/problem+json</div>
760 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
761 <h3 class="field-label">Example data</h3>
762 <div class="example-data-content-type">Content-Type: application/problem+json</div>
763 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
764 <h3 class="field-label">Example data</h3>
765 <div class="example-data-content-type">Content-Type: application/problem+json</div>
766 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
767 <h3 class="field-label">Example data</h3>
768 <div class="example-data-content-type">Content-Type: application/problem+json</div>
769 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
770 <h3 class="field-label">Example data</h3>
771 <div class="example-data-content-type">Content-Type: application/problem+json</div>
772 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
773
774 <h3 class="field-label">Produces</h3>
775 This API call produces the following media types according to the <span class="header">Accept</span> request header;
776 the media type will be conveyed by the <span class="header">Content-Type</span> response header.
777 <ul>
778 <li><code>application/problem+json</code></li>
779 </ul>
780
781 <h3 class="field-label">Responses</h3>
782 <h4 class="field-label">204</h4>
783 No Content
784 <a href="#"></a>
785 <h4 class="field-label">400</h4>
786 Bad Request
787 <a href="#ErrorMessage">ErrorMessage</a>
788 <h4 class="field-label">401</h4>
789 Unauthorized
790 <a href="#ErrorMessage">ErrorMessage</a>
791 <h4 class="field-label">403</h4>
792 Forbidden
793 <a href="#ErrorMessage">ErrorMessage</a>
794 <h4 class="field-label">409</h4>
795 Conflict
796 <a href="#ErrorMessage">ErrorMessage</a>
797 <h4 class="field-label">500</h4>
798 Internal Server Error
799 <a href="#ErrorMessage">ErrorMessage</a>
800 </div> <!-- method -->
801 <hr/>
802 <h1><a name="Decorators">Decorators</a></h1>
803 <div class="method"><a name="updateDecorator"/>
804 <div class="method-path">
805 <a class="up" href="#__Methods">Up</a>
806 <pre class="put"><code class="huge"><span class="http-method">put</span> /decorators</code></pre></div>
807 <div class="method-summary">Update entities and/or relationships with decorator(s). (<span class="nickname">updateDecorator</span>)</div>
808 <div class="method-notes">Update entities and/or relationships with decorator(s).</div>
809
810
811 <h3 class="field-label">Consumes</h3>
812 This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
813 <ul>
814 <li><code>application/json</code></li>
815 </ul>
816
817 <h3 class="field-label">Request body</h3>
818 <div class="field-items">
819 <div class="param">Decorator <a href="#Decorator">Decorator</a> (required)</div>
820
821 <div class="param-desc"><span class="param-type">Body Parameter</span> &mdash; </div>
822
823 </div> <!-- field-items -->
824
825 <h3 class="field-label">Request headers</h3>
826 <div class="field-items">
827 <div class="param">Accept (required)</div>
828
829 <div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: application/json </div>
830<div class="param">Content-Type (required)</div>
831
832 <div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: application/json </div>
833
834 </div> <!-- field-items -->
835
836
837
838
839 <!--Todo: process Response Object and its headers, schema, examples -->
840
841 <h3 class="field-label">Example data</h3>
842 <div class="example-data-content-type">Content-Type: application/problem+json</div>
843 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
844 <h3 class="field-label">Example data</h3>
845 <div class="example-data-content-type">Content-Type: application/problem+json</div>
846 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
847 <h3 class="field-label">Example data</h3>
848 <div class="example-data-content-type">Content-Type: application/problem+json</div>
849 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
850 <h3 class="field-label">Example data</h3>
851 <div class="example-data-content-type">Content-Type: application/problem+json</div>
852 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
853 <h3 class="field-label">Example data</h3>
854 <div class="example-data-content-type">Content-Type: application/problem+json</div>
855 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
856
857 <h3 class="field-label">Produces</h3>
858 This API call produces the following media types according to the <span class="header">Accept</span> request header;
859 the media type will be conveyed by the <span class="header">Content-Type</span> response header.
860 <ul>
861 <li><code>application/problem+json</code></li>
862 </ul>
863
864 <h3 class="field-label">Responses</h3>
865 <h4 class="field-label">204</h4>
866 No Content
867 <a href="#"></a>
868 <h4 class="field-label">400</h4>
869 Bad Request
870 <a href="#ErrorMessage">ErrorMessage</a>
871 <h4 class="field-label">401</h4>
872 Unauthorized
873 <a href="#ErrorMessage">ErrorMessage</a>
874 <h4 class="field-label">403</h4>
875 Forbidden
876 <a href="#ErrorMessage">ErrorMessage</a>
877 <h4 class="field-label">409</h4>
878 Conflict
879 <a href="#ErrorMessage">ErrorMessage</a>
880 <h4 class="field-label">500</h4>
881 Internal Server Error
882 <a href="#ErrorMessage">ErrorMessage</a>
883 </div> <!-- method -->
884 <hr/>
885 <h1><a name="EntitiesAndRelationships">EntitiesAndRelationships</a></h1>
886 <div class="method"><a name="getAllDomains"/>
887 <div class="method-path">
888 <a class="up" href="#__Methods">Up</a>
889 <pre class="get"><code class="huge"><span class="http-method">get</span> /domains</code></pre></div>
890 <div class="method-summary">Get all the available topology domains. (<span class="nickname">getAllDomains</span>)</div>
891 <div class="method-notes">Get all the available topology domains.</div>
892
893
894
895
896 <h3 class="field-label">Request headers</h3>
897 <div class="field-items">
898 <div class="param">Accept (required)</div>
899
900 <div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: application/json </div>
901
902 </div> <!-- field-items -->
903
904 <h3 class="field-label">Query parameters</h3>
905 <div class="field-items">
906 <div class="param">offset (optional)</div>
907
908 <div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Pagination offset. default: 0 </div><div class="param">limit (optional)</div>
909
910 <div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Result limiter. default: 500 </div>
911 </div> <!-- field-items -->
912
913
914 <h3 class="field-label">Return type</h3>
915 <div class="return-type">
916 <a href="#Domains">Domains</a>
917
918 </div>
919
920 <!--Todo: process Response Object and its headers, schema, examples -->
921
922 <h3 class="field-label">Example data</h3>
923 <div class="example-data-content-type">Content-Type: application/json</div>
924 <pre class="example"><code>{
925 "next" : {
926 "href" : "href"
927 },
928 "last" : {
929 "href" : "href"
930 },
931 "prev" : {
932 "href" : "href"
933 },
934 "self" : {
935 "href" : "href"
936 },
937 "totalCount" : 0,
938 "items" : [ {
939 "name" : "name",
940 "entityTypes" : {
941 "href" : "href"
942 },
943 "relationshipTypes" : {
944 "href" : "href"
945 }
946 }, {
947 "name" : "name",
948 "entityTypes" : {
949 "href" : "href"
950 },
951 "relationshipTypes" : {
952 "href" : "href"
953 }
954 } ],
955 "first" : {
956 "href" : "href"
957 }
958}</code></pre>
959 <h3 class="field-label">Example data</h3>
960 <div class="example-data-content-type">Content-Type: application/problem+json</div>
961 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
962 <h3 class="field-label">Example data</h3>
963 <div class="example-data-content-type">Content-Type: application/problem+json</div>
964 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
965 <h3 class="field-label">Example data</h3>
966 <div class="example-data-content-type">Content-Type: application/problem+json</div>
967 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
968 <h3 class="field-label">Example data</h3>
969 <div class="example-data-content-type">Content-Type: application/problem+json</div>
970 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
971
972 <h3 class="field-label">Produces</h3>
973 This API call produces the following media types according to the <span class="header">Accept</span> request header;
974 the media type will be conveyed by the <span class="header">Content-Type</span> response header.
975 <ul>
976 <li><code>application/json</code></li>
977 <li><code>application/problem+json</code></li>
978 </ul>
979
980 <h3 class="field-label">Responses</h3>
981 <h4 class="field-label">200</h4>
982 OK
983 <a href="#Domains">Domains</a>
984 <h4 class="field-label">400</h4>
985 Bad Request
986 <a href="#ErrorMessage">ErrorMessage</a>
987 <h4 class="field-label">401</h4>
988 Unauthorized
989 <a href="#ErrorMessage">ErrorMessage</a>
990 <h4 class="field-label">403</h4>
991 Forbidden
992 <a href="#ErrorMessage">ErrorMessage</a>
993 <h4 class="field-label">500</h4>
994 Internal Server Error
995 <a href="#ErrorMessage">ErrorMessage</a>
996 </div> <!-- method -->
997 <hr/>
998 <div class="method"><a name="getAllRelationshipsForEntityId"/>
999 <div class="method-path">
1000 <a class="up" href="#__Methods">Up</a>
1001 <pre class="get"><code class="huge"><span class="http-method">get</span> /domains/{domainName}/entity-types/{entityTypeName}/entities/{entityId}/relationships</code></pre></div>
1002 <div class="method-summary">Get all relationships for entity type name with specified id. Specified id represents the entity instance. (<span class="nickname">getAllRelationshipsForEntityId</span>)</div>
1003 <div class="method-notes">Get all relationships for entity type name with specified id. Specified id represents the entity instance.</div>
1004
1005 <h3 class="field-label">Path parameters</h3>
1006 <div class="field-items">
1007 <div class="param">domainName (required)</div>
1008
1009 <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; domain name default: null </div><div class="param">entityTypeName (required)</div>
1010
1011 <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; default: null </div><div class="param">entityId (required)</div>
1012
1013 <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; default: null </div>
1014 </div> <!-- field-items -->
1015
1016
1017
1018 <h3 class="field-label">Request headers</h3>
1019 <div class="field-items">
1020 <div class="param">Accept (required)</div>
1021
1022 <div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: application/json </div>
1023
1024 </div> <!-- field-items -->
1025
1026 <h3 class="field-label">Query parameters</h3>
1027 <div class="field-items">
1028 <div class="param">offset (optional)</div>
1029
1030 <div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Pagination offset. default: 0 </div><div class="param">limit (optional)</div>
1031
1032 <div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Result limiter. default: 500 </div>
1033 </div> <!-- field-items -->
1034
1035
1036 <h3 class="field-label">Return type</h3>
1037 <div class="return-type">
1038 <a href="#RelationshipsResponseMessage">RelationshipsResponseMessage</a>
1039
1040 </div>
1041
1042 <!--Todo: process Response Object and its headers, schema, examples -->
1043
1044 <h3 class="field-label">Example data</h3>
1045 <div class="example-data-content-type">Content-Type: application/json</div>
1046 <pre class="example"><code>{
1047 "next" : {
1048 "href" : "href"
1049 },
1050 "last" : {
1051 "href" : "href"
1052 },
1053 "prev" : {
1054 "href" : "href"
1055 },
1056 "self" : {
1057 "href" : "href"
1058 },
1059 "totalCount" : 0,
1060 "items" : [ "{}", "{}" ],
1061 "first" : {
1062 "href" : "href"
1063 }
1064}</code></pre>
1065 <h3 class="field-label">Example data</h3>
1066 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1067 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1068 <h3 class="field-label">Example data</h3>
1069 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1070 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1071 <h3 class="field-label">Example data</h3>
1072 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1073 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1074 <h3 class="field-label">Example data</h3>
1075 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1076 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1077 <h3 class="field-label">Example data</h3>
1078 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1079 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1080
1081 <h3 class="field-label">Produces</h3>
1082 This API call produces the following media types according to the <span class="header">Accept</span> request header;
1083 the media type will be conveyed by the <span class="header">Content-Type</span> response header.
1084 <ul>
1085 <li><code>application/json</code></li>
1086 <li><code>application/problem+json</code></li>
1087 </ul>
1088
1089 <h3 class="field-label">Responses</h3>
1090 <h4 class="field-label">200</h4>
1091 OK
1092 <a href="#RelationshipsResponseMessage">RelationshipsResponseMessage</a>
1093 <h4 class="field-label">400</h4>
1094 Bad Request
1095 <a href="#ErrorMessage">ErrorMessage</a>
1096 <h4 class="field-label">401</h4>
1097 Unauthorized
1098 <a href="#ErrorMessage">ErrorMessage</a>
1099 <h4 class="field-label">403</h4>
1100 Forbidden
1101 <a href="#ErrorMessage">ErrorMessage</a>
1102 <h4 class="field-label">404</h4>
1103 Not Found
1104 <a href="#ErrorMessage">ErrorMessage</a>
1105 <h4 class="field-label">500</h4>
1106 Internal Server Error
1107 <a href="#ErrorMessage">ErrorMessage</a>
1108 </div> <!-- method -->
1109 <hr/>
1110 <div class="method"><a name="getEntitiesByDomain"/>
1111 <div class="method-path">
1112 <a class="up" href="#__Methods">Up</a>
1113 <pre class="get"><code class="huge"><span class="http-method">get</span> /domains/{domainName}/entities</code></pre></div>
1114 <div class="method-summary">Get entities by domain (<span class="nickname">getEntitiesByDomain</span>)</div>
1115 <div class="method-notes">Get topology entities by domain, using specified targetFilter as mandatory query parameter.</div>
1116
1117 <h3 class="field-label">Path parameters</h3>
1118 <div class="field-items">
1119 <div class="param">domainName (required)</div>
1120
1121 <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; domain name default: null </div>
1122 </div> <!-- field-items -->
1123
1124
1125
1126 <h3 class="field-label">Request headers</h3>
1127 <div class="field-items">
1128 <div class="param">Accept (required)</div>
1129
1130 <div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: application/json </div>
1131
1132 </div> <!-- field-items -->
1133
1134 <h3 class="field-label">Query parameters</h3>
1135 <div class="field-items">
1136 <div class="param">targetFilter (optional)</div>
1137
1138 <div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Use <em>targetFilter</em> to specify the entity type and attributes to be returned in the REST response. The value for <em>targetFilter</em> can also be a list of entity types and attributes. default: null </div><div class="param">scopeFilter (optional)</div>
1139
1140 <div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Use <em>scopeFilter</em> to specify the attributes to match on. The value for <em>scopeFilter</em> can also be a list of entity types and attributes. scopeFilter returns a boolean. default: null </div><div class="param">offset (optional)</div>
1141
1142 <div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Pagination offset. default: 0 </div><div class="param">limit (optional)</div>
1143
1144 <div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Result limiter. default: 500 </div>
1145 </div> <!-- field-items -->
1146
1147
1148 <h3 class="field-label">Return type</h3>
1149 <div class="return-type">
1150 <a href="#EntitiesResponseMessage">EntitiesResponseMessage</a>
1151
1152 </div>
1153
1154 <!--Todo: process Response Object and its headers, schema, examples -->
1155
1156 <h3 class="field-label">Example data</h3>
1157 <div class="example-data-content-type">Content-Type: application/json</div>
1158 <pre class="example"><code>{
1159 "next" : {
1160 "href" : "href"
1161 },
1162 "last" : {
1163 "href" : "href"
1164 },
1165 "prev" : {
1166 "href" : "href"
1167 },
1168 "self" : {
1169 "href" : "href"
1170 },
1171 "totalCount" : 0,
1172 "items" : [ "{}", "{}" ],
1173 "first" : {
1174 "href" : "href"
1175 }
1176}</code></pre>
1177 <h3 class="field-label">Example data</h3>
1178 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1179 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1180 <h3 class="field-label">Example data</h3>
1181 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1182 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1183 <h3 class="field-label">Example data</h3>
1184 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1185 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1186 <h3 class="field-label">Example data</h3>
1187 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1188 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1189
1190 <h3 class="field-label">Produces</h3>
1191 This API call produces the following media types according to the <span class="header">Accept</span> request header;
1192 the media type will be conveyed by the <span class="header">Content-Type</span> response header.
1193 <ul>
1194 <li><code>application/json</code></li>
1195 <li><code>application/problem+json</code></li>
1196 </ul>
1197
1198 <h3 class="field-label">Responses</h3>
1199 <h4 class="field-label">200</h4>
1200 OK
1201 <a href="#EntitiesResponseMessage">EntitiesResponseMessage</a>
1202 <h4 class="field-label">400</h4>
1203 Bad Request
1204 <a href="#ErrorMessage">ErrorMessage</a>
1205 <h4 class="field-label">401</h4>
1206 Unauthorized
1207 <a href="#ErrorMessage">ErrorMessage</a>
1208 <h4 class="field-label">403</h4>
1209 Forbidden
1210 <a href="#ErrorMessage">ErrorMessage</a>
1211 <h4 class="field-label">500</h4>
1212 Internal Server Error
1213 <a href="#ErrorMessage">ErrorMessage</a>
1214 </div> <!-- method -->
1215 <hr/>
1216 <div class="method"><a name="getRelationshipById"/>
1217 <div class="method-path">
1218 <a class="up" href="#__Methods">Up</a>
1219 <pre class="get"><code class="huge"><span class="http-method">get</span> /domains/{domainName}/relationship-types/{relationshipTypeName}/relationships/{relationshipId}</code></pre></div>
1220 <div class="method-summary">Get relationship with specified id. Specified id represents the relationship instance. (<span class="nickname">getRelationshipById</span>)</div>
1221 <div class="method-notes">Get relationship with specified id. Specified id represents the relationship instance.</div>
1222
1223 <h3 class="field-label">Path parameters</h3>
1224 <div class="field-items">
1225 <div class="param">domainName (required)</div>
1226
1227 <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; domain name default: null </div><div class="param">relationshipTypeName (required)</div>
1228
1229 <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; default: null </div><div class="param">relationshipId (required)</div>
1230
1231 <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; default: null </div>
1232 </div> <!-- field-items -->
1233
1234
1235
1236 <h3 class="field-label">Request headers</h3>
1237 <div class="field-items">
1238 <div class="param">Accept (required)</div>
1239
1240 <div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: application/json </div>
1241
1242 </div> <!-- field-items -->
1243
1244
1245
1246 <h3 class="field-label">Return type</h3>
1247 <div class="return-type">
1248
1249 Object
1250 </div>
1251
1252 <!--Todo: process Response Object and its headers, schema, examples -->
1253
1254 <h3 class="field-label">Example data</h3>
1255 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1256 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1257 <h3 class="field-label">Example data</h3>
1258 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1259 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1260 <h3 class="field-label">Example data</h3>
1261 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1262 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1263 <h3 class="field-label">Example data</h3>
1264 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1265 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1266 <h3 class="field-label">Example data</h3>
1267 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1268 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1269
1270 <h3 class="field-label">Produces</h3>
1271 This API call produces the following media types according to the <span class="header">Accept</span> request header;
1272 the media type will be conveyed by the <span class="header">Content-Type</span> response header.
1273 <ul>
1274 <li><code>application/yang.data+json</code></li>
1275 <li><code>application/problem+json</code></li>
1276 </ul>
1277
1278 <h3 class="field-label">Responses</h3>
1279 <h4 class="field-label">200</h4>
1280 OK
1281 <a href="#Object">Object</a>
1282 <h4 class="field-label">400</h4>
1283 Bad Request
1284 <a href="#ErrorMessage">ErrorMessage</a>
1285 <h4 class="field-label">401</h4>
1286 Unauthorized
1287 <a href="#ErrorMessage">ErrorMessage</a>
1288 <h4 class="field-label">403</h4>
1289 Forbidden
1290 <a href="#ErrorMessage">ErrorMessage</a>
1291 <h4 class="field-label">404</h4>
1292 Not Found
1293 <a href="#ErrorMessage">ErrorMessage</a>
1294 <h4 class="field-label">500</h4>
1295 Internal Server Error
1296 <a href="#ErrorMessage">ErrorMessage</a>
1297 </div> <!-- method -->
1298 <hr/>
1299 <div class="method"><a name="getRelationshipsByType"/>
1300 <div class="method-path">
1301 <a class="up" href="#__Methods">Up</a>
1302 <pre class="get"><code class="huge"><span class="http-method">get</span> /domains/{domainName}/relationship-types/{relationshipTypeName}/relationships</code></pre></div>
1303 <div class="method-summary">Get topology relationships of a specific relationship type name. (<span class="nickname">getRelationshipsByType</span>)</div>
1304 <div class="method-notes">Get topology relationships of a specific relationship type name.</div>
1305
1306 <h3 class="field-label">Path parameters</h3>
1307 <div class="field-items">
1308 <div class="param">domainName (required)</div>
1309
1310 <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; domain name default: null </div><div class="param">relationshipTypeName (required)</div>
1311
1312 <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; default: null </div>
1313 </div> <!-- field-items -->
1314
1315
1316
1317 <h3 class="field-label">Request headers</h3>
1318 <div class="field-items">
1319 <div class="param">Accept (required)</div>
1320
1321 <div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: application/json </div>
1322
1323 </div> <!-- field-items -->
1324
1325 <h3 class="field-label">Query parameters</h3>
1326 <div class="field-items">
1327 <div class="param">targetFilter (optional)</div>
1328
1329 <div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Use <em>targetFilter</em> to specify the entity type and attributes to be returned in the REST response. The value for <em>targetFilter</em> can also be a list of entity types and attributes. default: null </div><div class="param">scopeFilter (optional)</div>
1330
1331 <div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Use <em>scopeFilter</em> to specify the attributes to match on. The value for <em>scopeFilter</em> can also be a list of entity types and attributes. scopeFilter returns a boolean. default: null </div><div class="param">offset (optional)</div>
1332
1333 <div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Pagination offset. default: 0 </div><div class="param">limit (optional)</div>
1334
1335 <div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Result limiter. default: 500 </div>
1336 </div> <!-- field-items -->
1337
1338
1339 <h3 class="field-label">Return type</h3>
1340 <div class="return-type">
1341 <a href="#RelationshipsResponseMessage">RelationshipsResponseMessage</a>
1342
1343 </div>
1344
1345 <!--Todo: process Response Object and its headers, schema, examples -->
1346
1347 <h3 class="field-label">Example data</h3>
1348 <div class="example-data-content-type">Content-Type: application/json</div>
1349 <pre class="example"><code>{
1350 "next" : {
1351 "href" : "href"
1352 },
1353 "last" : {
1354 "href" : "href"
1355 },
1356 "prev" : {
1357 "href" : "href"
1358 },
1359 "self" : {
1360 "href" : "href"
1361 },
1362 "totalCount" : 0,
1363 "items" : [ "{}", "{}" ],
1364 "first" : {
1365 "href" : "href"
1366 }
1367}</code></pre>
1368 <h3 class="field-label">Example data</h3>
1369 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1370 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1371 <h3 class="field-label">Example data</h3>
1372 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1373 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1374 <h3 class="field-label">Example data</h3>
1375 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1376 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1377 <h3 class="field-label">Example data</h3>
1378 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1379 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1380
1381 <h3 class="field-label">Produces</h3>
1382 This API call produces the following media types according to the <span class="header">Accept</span> request header;
1383 the media type will be conveyed by the <span class="header">Content-Type</span> response header.
1384 <ul>
1385 <li><code>application/json</code></li>
1386 <li><code>application/problem+json</code></li>
1387 </ul>
1388
1389 <h3 class="field-label">Responses</h3>
1390 <h4 class="field-label">200</h4>
1391 OK
1392 <a href="#RelationshipsResponseMessage">RelationshipsResponseMessage</a>
1393 <h4 class="field-label">400</h4>
1394 Bad Request
1395 <a href="#ErrorMessage">ErrorMessage</a>
1396 <h4 class="field-label">401</h4>
1397 Unauthorized
1398 <a href="#ErrorMessage">ErrorMessage</a>
1399 <h4 class="field-label">403</h4>
1400 Forbidden
1401 <a href="#ErrorMessage">ErrorMessage</a>
1402 <h4 class="field-label">500</h4>
1403 Internal Server Error
1404 <a href="#ErrorMessage">ErrorMessage</a>
1405 </div> <!-- method -->
1406 <hr/>
1407 <div class="method"><a name="getTopologyByEntityTypeName"/>
1408 <div class="method-path">
1409 <a class="up" href="#__Methods">Up</a>
1410 <pre class="get"><code class="huge"><span class="http-method">get</span> /domains/{domainName}/entity-types/{entityTypeName}/entities</code></pre></div>
1411 <div class="method-summary">Get all topology entities of a specific entity type. (<span class="nickname">getTopologyByEntityTypeName</span>)</div>
1412 <div class="method-notes">Get all topology entities of a specific entity type.</div>
1413
1414 <h3 class="field-label">Path parameters</h3>
1415 <div class="field-items">
1416 <div class="param">domainName (required)</div>
1417
1418 <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; domain name default: null </div><div class="param">entityTypeName (required)</div>
1419
1420 <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; default: null </div>
1421 </div> <!-- field-items -->
1422
1423
1424
1425 <h3 class="field-label">Request headers</h3>
1426 <div class="field-items">
1427 <div class="param">Accept (required)</div>
1428
1429 <div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: application/json </div>
1430
1431 </div> <!-- field-items -->
1432
1433 <h3 class="field-label">Query parameters</h3>
1434 <div class="field-items">
1435 <div class="param">targetFilter (optional)</div>
1436
1437 <div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Use <em>targetFilter</em> to specify the entity type and attributes to be returned in the REST response. The value for <em>targetFilter</em> can also be a list of entity types and attributes. default: null </div><div class="param">scopeFilter (optional)</div>
1438
1439 <div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Use <em>scopeFilter</em> to specify the attributes to match on. The value for <em>scopeFilter</em> can also be a list of entity types and attributes. scopeFilter returns a boolean. default: null </div><div class="param">offset (optional)</div>
1440
1441 <div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Pagination offset. default: 0 </div><div class="param">limit (optional)</div>
1442
1443 <div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Result limiter. default: 500 </div>
1444 </div> <!-- field-items -->
1445
1446
1447 <h3 class="field-label">Return type</h3>
1448 <div class="return-type">
1449 <a href="#EntitiesResponseMessage">EntitiesResponseMessage</a>
1450
1451 </div>
1452
1453 <!--Todo: process Response Object and its headers, schema, examples -->
1454
1455 <h3 class="field-label">Example data</h3>
1456 <div class="example-data-content-type">Content-Type: application/json</div>
1457 <pre class="example"><code>{
1458 "next" : {
1459 "href" : "href"
1460 },
1461 "last" : {
1462 "href" : "href"
1463 },
1464 "prev" : {
1465 "href" : "href"
1466 },
1467 "self" : {
1468 "href" : "href"
1469 },
1470 "totalCount" : 0,
1471 "items" : [ "{}", "{}" ],
1472 "first" : {
1473 "href" : "href"
1474 }
1475}</code></pre>
1476 <h3 class="field-label">Example data</h3>
1477 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1478 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1479 <h3 class="field-label">Example data</h3>
1480 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1481 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1482 <h3 class="field-label">Example data</h3>
1483 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1484 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1485 <h3 class="field-label">Example data</h3>
1486 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1487 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1488
1489 <h3 class="field-label">Produces</h3>
1490 This API call produces the following media types according to the <span class="header">Accept</span> request header;
1491 the media type will be conveyed by the <span class="header">Content-Type</span> response header.
1492 <ul>
1493 <li><code>application/json</code></li>
1494 <li><code>application/problem+json</code></li>
1495 </ul>
1496
1497 <h3 class="field-label">Responses</h3>
1498 <h4 class="field-label">200</h4>
1499 OK
1500 <a href="#EntitiesResponseMessage">EntitiesResponseMessage</a>
1501 <h4 class="field-label">400</h4>
1502 Bad Request
1503 <a href="#ErrorMessage">ErrorMessage</a>
1504 <h4 class="field-label">401</h4>
1505 Unauthorized
1506 <a href="#ErrorMessage">ErrorMessage</a>
1507 <h4 class="field-label">403</h4>
1508 Forbidden
1509 <a href="#ErrorMessage">ErrorMessage</a>
1510 <h4 class="field-label">500</h4>
1511 Internal Server Error
1512 <a href="#ErrorMessage">ErrorMessage</a>
1513 </div> <!-- method -->
1514 <hr/>
1515 <div class="method"><a name="getTopologyById"/>
1516 <div class="method-path">
1517 <a class="up" href="#__Methods">Up</a>
1518 <pre class="get"><code class="huge"><span class="http-method">get</span> /domains/{domainName}/entity-types/{entityTypeName}/entities/{entityId}</code></pre></div>
1519 <div class="method-summary">Get topology for entity type name with specified id. Specified id represents the entity instance. (<span class="nickname">getTopologyById</span>)</div>
1520 <div class="method-notes">Get topology for entity type name with specified id. Specified id represents the entity instance.</div>
1521
1522 <h3 class="field-label">Path parameters</h3>
1523 <div class="field-items">
1524 <div class="param">domainName (required)</div>
1525
1526 <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; domain name default: null </div><div class="param">entityTypeName (required)</div>
1527
1528 <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; default: null </div><div class="param">entityId (required)</div>
1529
1530 <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; default: null </div>
1531 </div> <!-- field-items -->
1532
1533
1534
1535 <h3 class="field-label">Request headers</h3>
1536 <div class="field-items">
1537 <div class="param">Accept (required)</div>
1538
1539 <div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: application/json </div>
1540
1541 </div> <!-- field-items -->
1542
1543
1544
1545 <h3 class="field-label">Return type</h3>
1546 <div class="return-type">
1547
1548 Object
1549 </div>
1550
1551 <!--Todo: process Response Object and its headers, schema, examples -->
1552
1553 <h3 class="field-label">Example data</h3>
1554 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1555 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1556 <h3 class="field-label">Example data</h3>
1557 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1558 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1559 <h3 class="field-label">Example data</h3>
1560 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1561 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1562 <h3 class="field-label">Example data</h3>
1563 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1564 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1565 <h3 class="field-label">Example data</h3>
1566 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1567 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1568
1569 <h3 class="field-label">Produces</h3>
1570 This API call produces the following media types according to the <span class="header">Accept</span> request header;
1571 the media type will be conveyed by the <span class="header">Content-Type</span> response header.
1572 <ul>
1573 <li><code>application/yang.data+json</code></li>
1574 <li><code>application/problem+json</code></li>
1575 </ul>
1576
1577 <h3 class="field-label">Responses</h3>
1578 <h4 class="field-label">200</h4>
1579 OK
1580 <a href="#Object">Object</a>
1581 <h4 class="field-label">400</h4>
1582 Bad Request
1583 <a href="#ErrorMessage">ErrorMessage</a>
1584 <h4 class="field-label">401</h4>
1585 Unauthorized
1586 <a href="#ErrorMessage">ErrorMessage</a>
1587 <h4 class="field-label">403</h4>
1588 Forbidden
1589 <a href="#ErrorMessage">ErrorMessage</a>
1590 <h4 class="field-label">404</h4>
1591 Not Found
1592 <a href="#ErrorMessage">ErrorMessage</a>
1593 <h4 class="field-label">500</h4>
1594 Internal Server Error
1595 <a href="#ErrorMessage">ErrorMessage</a>
1596 </div> <!-- method -->
1597 <hr/>
1598 <div class="method"><a name="getTopologyEntityTypes"/>
1599 <div class="method-path">
1600 <a class="up" href="#__Methods">Up</a>
1601 <pre class="get"><code class="huge"><span class="http-method">get</span> /domains/{domainName}/entity-types</code></pre></div>
1602 <div class="method-summary">Get all the available topology entity types in domain name. (<span class="nickname">getTopologyEntityTypes</span>)</div>
1603 <div class="method-notes">Get all the available topology entity types in domain name.</div>
1604
1605 <h3 class="field-label">Path parameters</h3>
1606 <div class="field-items">
1607 <div class="param">domainName (required)</div>
1608
1609 <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; domain name default: null </div>
1610 </div> <!-- field-items -->
1611
1612
1613
1614 <h3 class="field-label">Request headers</h3>
1615 <div class="field-items">
1616 <div class="param">Accept (required)</div>
1617
1618 <div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: application/json </div>
1619
1620 </div> <!-- field-items -->
1621
1622 <h3 class="field-label">Query parameters</h3>
1623 <div class="field-items">
1624 <div class="param">offset (optional)</div>
1625
1626 <div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Pagination offset. default: 0 </div><div class="param">limit (optional)</div>
1627
1628 <div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Result limiter. default: 500 </div>
1629 </div> <!-- field-items -->
1630
1631
1632 <h3 class="field-label">Return type</h3>
1633 <div class="return-type">
1634 <a href="#EntityTypes">EntityTypes</a>
1635
1636 </div>
1637
1638 <!--Todo: process Response Object and its headers, schema, examples -->
1639
1640 <h3 class="field-label">Example data</h3>
1641 <div class="example-data-content-type">Content-Type: application/json</div>
1642 <pre class="example"><code>{
1643 "next" : {
1644 "href" : "href"
1645 },
1646 "last" : {
1647 "href" : "href"
1648 },
1649 "prev" : {
1650 "href" : "href"
1651 },
1652 "self" : {
1653 "href" : "href"
1654 },
1655 "totalCount" : 0,
1656 "items" : [ {
1657 "entities" : {
1658 "href" : "href"
1659 },
1660 "name" : "name"
1661 }, {
1662 "entities" : {
1663 "href" : "href"
1664 },
1665 "name" : "name"
1666 } ],
1667 "first" : {
1668 "href" : "href"
1669 }
1670}</code></pre>
1671 <h3 class="field-label">Example data</h3>
1672 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1673 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1674 <h3 class="field-label">Example data</h3>
1675 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1676 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1677 <h3 class="field-label">Example data</h3>
1678 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1679 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1680 <h3 class="field-label">Example data</h3>
1681 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1682 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1683
1684 <h3 class="field-label">Produces</h3>
1685 This API call produces the following media types according to the <span class="header">Accept</span> request header;
1686 the media type will be conveyed by the <span class="header">Content-Type</span> response header.
1687 <ul>
1688 <li><code>application/json</code></li>
1689 <li><code>application/problem+json</code></li>
1690 </ul>
1691
1692 <h3 class="field-label">Responses</h3>
1693 <h4 class="field-label">200</h4>
1694 OK
1695 <a href="#EntityTypes">EntityTypes</a>
1696 <h4 class="field-label">400</h4>
1697 Bad Request
1698 <a href="#ErrorMessage">ErrorMessage</a>
1699 <h4 class="field-label">401</h4>
1700 Unauthorized
1701 <a href="#ErrorMessage">ErrorMessage</a>
1702 <h4 class="field-label">403</h4>
1703 Forbidden
1704 <a href="#ErrorMessage">ErrorMessage</a>
1705 <h4 class="field-label">500</h4>
1706 Internal Server Error
1707 <a href="#ErrorMessage">ErrorMessage</a>
1708 </div> <!-- method -->
1709 <hr/>
1710 <div class="method"><a name="getTopologyRelationshipTypes"/>
1711 <div class="method-path">
1712 <a class="up" href="#__Methods">Up</a>
1713 <pre class="get"><code class="huge"><span class="http-method">get</span> /domains/{domainName}/relationship-types</code></pre></div>
1714 <div class="method-summary">Get all the available topology relationship types. (<span class="nickname">getTopologyRelationshipTypes</span>)</div>
1715 <div class="method-notes">Get all the available topology relationship types.</div>
1716
1717 <h3 class="field-label">Path parameters</h3>
1718 <div class="field-items">
1719 <div class="param">domainName (required)</div>
1720
1721 <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; domain name default: null </div>
1722 </div> <!-- field-items -->
1723
1724
1725
1726 <h3 class="field-label">Request headers</h3>
1727 <div class="field-items">
1728 <div class="param">Accept (required)</div>
1729
1730 <div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: application/json </div>
1731
1732 </div> <!-- field-items -->
1733
1734 <h3 class="field-label">Query parameters</h3>
1735 <div class="field-items">
1736 <div class="param">offset (optional)</div>
1737
1738 <div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Pagination offset. default: 0 </div><div class="param">limit (optional)</div>
1739
1740 <div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Result limiter. default: 500 </div>
1741 </div> <!-- field-items -->
1742
1743
1744 <h3 class="field-label">Return type</h3>
1745 <div class="return-type">
1746 <a href="#RelationshipTypes">RelationshipTypes</a>
1747
1748 </div>
1749
1750 <!--Todo: process Response Object and its headers, schema, examples -->
1751
1752 <h3 class="field-label">Example data</h3>
1753 <div class="example-data-content-type">Content-Type: application/json</div>
1754 <pre class="example"><code>{
1755 "next" : {
1756 "href" : "href"
1757 },
1758 "last" : {
1759 "href" : "href"
1760 },
1761 "prev" : {
1762 "href" : "href"
1763 },
1764 "self" : {
1765 "href" : "href"
1766 },
1767 "totalCount" : 0,
1768 "items" : [ {
1769 "relationships" : {
1770 "href" : "href"
1771 },
1772 "name" : "name"
1773 }, {
1774 "relationships" : {
1775 "href" : "href"
1776 },
1777 "name" : "name"
1778 } ],
1779 "first" : {
1780 "href" : "href"
1781 }
1782}</code></pre>
1783 <h3 class="field-label">Example data</h3>
1784 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1785 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1786 <h3 class="field-label">Example data</h3>
1787 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1788 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1789 <h3 class="field-label">Example data</h3>
1790 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1791 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1792 <h3 class="field-label">Example data</h3>
1793 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1794 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1795
1796 <h3 class="field-label">Produces</h3>
1797 This API call produces the following media types according to the <span class="header">Accept</span> request header;
1798 the media type will be conveyed by the <span class="header">Content-Type</span> response header.
1799 <ul>
1800 <li><code>application/json</code></li>
1801 <li><code>application/problem+json</code></li>
1802 </ul>
1803
1804 <h3 class="field-label">Responses</h3>
1805 <h4 class="field-label">200</h4>
1806 OK
1807 <a href="#RelationshipTypes">RelationshipTypes</a>
1808 <h4 class="field-label">400</h4>
1809 Bad Request
1810 <a href="#ErrorMessage">ErrorMessage</a>
1811 <h4 class="field-label">401</h4>
1812 Unauthorized
1813 <a href="#ErrorMessage">ErrorMessage</a>
1814 <h4 class="field-label">403</h4>
1815 Forbidden
1816 <a href="#ErrorMessage">ErrorMessage</a>
1817 <h4 class="field-label">500</h4>
1818 Internal Server Error
1819 <a href="#ErrorMessage">ErrorMessage</a>
1820 </div> <!-- method -->
1821 <hr/>
1822 <h1><a name="GeoQuery">GeoQuery</a></h1>
1823 <div class="method"><a name="geoQueryTopologyAcrossDomains"/>
1824 <div class="method-path">
1825 <a class="up" href="#__Methods">Up</a>
1826 <pre class="post"><code class="huge"><span class="http-method">post</span> /geo-queries</code></pre></div>
1827 <div class="method-summary">Geo query topology entity or entities across topology domains. (<span class="nickname">geoQueryTopologyAcrossDomains</span>)</div>
1828 <div class="method-notes">Geo query topology entity or entities across topology domains.</div>
1829
1830
1831 <h3 class="field-label">Consumes</h3>
1832 This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
1833 <ul>
1834 <li><code>application/json</code></li>
1835 </ul>
1836
1837 <h3 class="field-label">Request body</h3>
1838 <div class="field-items">
1839 <div class="param">QueryMessage <a href="#QueryMessage">QueryMessage</a> (required)</div>
1840
1841 <div class="param-desc"><span class="param-type">Body Parameter</span> &mdash; </div>
1842
1843 </div> <!-- field-items -->
1844
1845 <h3 class="field-label">Request headers</h3>
1846 <div class="field-items">
1847 <div class="param">Accept (required)</div>
1848
1849 <div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: application/json </div>
1850<div class="param">Content-Type (required)</div>
1851
1852 <div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: application/json </div>
1853
1854 </div> <!-- field-items -->
1855
1856 <h3 class="field-label">Query parameters</h3>
1857 <div class="field-items">
1858 <div class="param">offset (optional)</div>
1859
1860 <div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Pagination offset. default: 0 </div><div class="param">limit (optional)</div>
1861
1862 <div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Result limiter. default: 500 </div>
1863 </div> <!-- field-items -->
1864
1865
1866 <h3 class="field-label">Return type</h3>
1867 <div class="return-type">
1868
1869 Object
1870 </div>
1871
1872 <!--Todo: process Response Object and its headers, schema, examples -->
1873
1874 <h3 class="field-label">Example data</h3>
1875 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1876 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1877 <h3 class="field-label">Example data</h3>
1878 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1879 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1880 <h3 class="field-label">Example data</h3>
1881 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1882 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1883 <h3 class="field-label">Example data</h3>
1884 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1885 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1886 <h3 class="field-label">Example data</h3>
1887 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1888 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1889
1890 <h3 class="field-label">Produces</h3>
1891 This API call produces the following media types according to the <span class="header">Accept</span> request header;
1892 the media type will be conveyed by the <span class="header">Content-Type</span> response header.
1893 <ul>
1894 <li><code>application/json</code></li>
1895 <li><code>application/problem+json</code></li>
1896 </ul>
1897
1898 <h3 class="field-label">Responses</h3>
1899 <h4 class="field-label">200</h4>
1900 OK
1901 <a href="#Object">Object</a>
1902 <h4 class="field-label">400</h4>
1903 Bad Request
1904 <a href="#ErrorMessage">ErrorMessage</a>
1905 <h4 class="field-label">401</h4>
1906 Unauthorized
1907 <a href="#ErrorMessage">ErrorMessage</a>
1908 <h4 class="field-label">403</h4>
1909 Forbidden
1910 <a href="#ErrorMessage">ErrorMessage</a>
1911 <h4 class="field-label">409</h4>
1912 Conflict
1913 <a href="#ErrorMessage">ErrorMessage</a>
1914 <h4 class="field-label">500</h4>
1915 Internal Server Error
1916 <a href="#ErrorMessage">ErrorMessage</a>
1917 </div> <!-- method -->
1918 <hr/>
1919 <h1><a name="Schemas">Schemas</a></h1>
1920 <div class="method"><a name="createSchema"/>
1921 <div class="method-path">
1922 <a class="up" href="#__Methods">Up</a>
1923 <pre class="post"><code class="huge"><span class="http-method">post</span> /schemas</code></pre></div>
1924 <div class="method-summary">Create a new schema. (<span class="nickname">createSchema</span>)</div>
1925 <div class="method-notes">Create a new schema.</div>
1926
1927
1928 <h3 class="field-label">Consumes</h3>
1929 This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
1930 <ul>
1931 <li><code>multipart/form-data</code></li>
1932 </ul>
1933
1934
1935 <h3 class="field-label">Request headers</h3>
1936 <div class="field-items">
1937 <div class="param">Accept (required)</div>
1938
1939 <div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: application/json </div>
1940<div class="param">Content-Type (required)</div>
1941
1942 <div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: application/json </div>
1943
1944 </div> <!-- field-items -->
1945
1946
1947 <h3 class="field-label">Form parameters</h3>
1948 <div class="field-items">
1949 <div class="param">file (required)</div>
1950
1951 <div class="param-desc"><span class="param-type">Form Parameter</span> &mdash; multipartFile default: null format: binary</div>
1952 </div> <!-- field-items -->
1953
1954
1955 <!--Todo: process Response Object and its headers, schema, examples -->
1956
1957 <h3 class="field-label">Example data</h3>
1958 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1959 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1960 <h3 class="field-label">Example data</h3>
1961 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1962 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1963 <h3 class="field-label">Example data</h3>
1964 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1965 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1966 <h3 class="field-label">Example data</h3>
1967 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1968 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1969 <h3 class="field-label">Example data</h3>
1970 <div class="example-data-content-type">Content-Type: application/problem+json</div>
1971 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
1972
1973 <h3 class="field-label">Produces</h3>
1974 This API call produces the following media types according to the <span class="header">Accept</span> request header;
1975 the media type will be conveyed by the <span class="header">Content-Type</span> response header.
1976 <ul>
1977 <li><code>application/problem+json</code></li>
1978 </ul>
1979
1980 <h3 class="field-label">Responses</h3>
1981 <h4 class="field-label">201</h4>
1982 Created without response body
1983 <a href="#"></a>
1984 <h4 class="field-label">400</h4>
1985 Bad Request
1986 <a href="#ErrorMessage">ErrorMessage</a>
1987 <h4 class="field-label">401</h4>
1988 Unauthorized
1989 <a href="#ErrorMessage">ErrorMessage</a>
1990 <h4 class="field-label">403</h4>
1991 Forbidden
1992 <a href="#ErrorMessage">ErrorMessage</a>
1993 <h4 class="field-label">409</h4>
1994 Conflict
1995 <a href="#ErrorMessage">ErrorMessage</a>
1996 <h4 class="field-label">500</h4>
1997 Internal Server Error
1998 <a href="#ErrorMessage">ErrorMessage</a>
1999 </div> <!-- method -->
2000 <hr/>
2001 <div class="method"><a name="deleteSchema"/>
2002 <div class="method-path">
2003 <a class="up" href="#__Methods">Up</a>
2004 <pre class="delete"><code class="huge"><span class="http-method">delete</span> /schemas/{schemaName}</code></pre></div>
2005 <div class="method-summary">Delete a schema. (<span class="nickname">deleteSchema</span>)</div>
2006 <div class="method-notes">Delete a schema.</div>
2007
2008 <h3 class="field-label">Path parameters</h3>
2009 <div class="field-items">
2010 <div class="param">schemaName (required)</div>
2011
2012 <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; default: o-ran-smo-teiv-ran </div>
2013 </div> <!-- field-items -->
2014
2015
2016
2017 <h3 class="field-label">Request headers</h3>
2018 <div class="field-items">
2019 <div class="param">Accept (required)</div>
2020
2021 <div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: application/json </div>
2022
2023 </div> <!-- field-items -->
2024
2025
2026
2027
2028 <!--Todo: process Response Object and its headers, schema, examples -->
2029
2030 <h3 class="field-label">Example data</h3>
2031 <div class="example-data-content-type">Content-Type: application/problem+json</div>
2032 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
2033 <h3 class="field-label">Example data</h3>
2034 <div class="example-data-content-type">Content-Type: application/problem+json</div>
2035 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
2036 <h3 class="field-label">Example data</h3>
2037 <div class="example-data-content-type">Content-Type: application/problem+json</div>
2038 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
2039 <h3 class="field-label">Example data</h3>
2040 <div class="example-data-content-type">Content-Type: application/problem+json</div>
2041 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
2042
2043 <h3 class="field-label">Produces</h3>
2044 This API call produces the following media types according to the <span class="header">Accept</span> request header;
2045 the media type will be conveyed by the <span class="header">Content-Type</span> response header.
2046 <ul>
2047 <li><code>application/problem+json</code></li>
2048 </ul>
2049
2050 <h3 class="field-label">Responses</h3>
2051 <h4 class="field-label">204</h4>
2052 No Content
2053 <a href="#"></a>
2054 <h4 class="field-label">400</h4>
2055 Bad Request
2056 <a href="#ErrorMessage">ErrorMessage</a>
2057 <h4 class="field-label">401</h4>
2058 Unauthorized
2059 <a href="#ErrorMessage">ErrorMessage</a>
2060 <h4 class="field-label">403</h4>
2061 Forbidden
2062 <a href="#ErrorMessage">ErrorMessage</a>
2063 <h4 class="field-label">500</h4>
2064 Internal Server Error
2065 <a href="#ErrorMessage">ErrorMessage</a>
2066 </div> <!-- method -->
2067 <hr/>
2068 <div class="method"><a name="getSchemaByName"/>
2069 <div class="method-path">
2070 <a class="up" href="#__Methods">Up</a>
2071 <pre class="get"><code class="huge"><span class="http-method">get</span> /schemas/{schemaName}/content</code></pre></div>
2072 <div class="method-summary">Get the model schema. (<span class="nickname">getSchemaByName</span>)</div>
2073 <div class="method-notes">Get the model schema by name.</div>
2074
2075 <h3 class="field-label">Path parameters</h3>
2076 <div class="field-items">
2077 <div class="param">schemaName (required)</div>
2078
2079 <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; default: o-ran-smo-teiv-ran </div>
2080 </div> <!-- field-items -->
2081
2082
2083
2084 <h3 class="field-label">Request headers</h3>
2085 <div class="field-items">
2086 <div class="param">Accept (required)</div>
2087
2088 <div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: application/json </div>
2089
2090 </div> <!-- field-items -->
2091
2092
2093
2094 <h3 class="field-label">Return type</h3>
2095 <div class="return-type">
2096
2097 String
2098 </div>
2099
2100 <!--Todo: process Response Object and its headers, schema, examples -->
2101
2102 <h3 class="field-label">Example data</h3>
2103 <div class="example-data-content-type">Content-Type: application/problem+json</div>
2104 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
2105 <h3 class="field-label">Example data</h3>
2106 <div class="example-data-content-type">Content-Type: application/problem+json</div>
2107 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
2108 <h3 class="field-label">Example data</h3>
2109 <div class="example-data-content-type">Content-Type: application/problem+json</div>
2110 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
2111 <h3 class="field-label">Example data</h3>
2112 <div class="example-data-content-type">Content-Type: application/problem+json</div>
2113 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
2114 <h3 class="field-label">Example data</h3>
2115 <div class="example-data-content-type">Content-Type: application/problem+json</div>
2116 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
2117
2118 <h3 class="field-label">Produces</h3>
2119 This API call produces the following media types according to the <span class="header">Accept</span> request header;
2120 the media type will be conveyed by the <span class="header">Content-Type</span> response header.
2121 <ul>
2122 <li><code>text/plain</code></li>
2123 <li><code>application/problem+json</code></li>
2124 </ul>
2125
2126 <h3 class="field-label">Responses</h3>
2127 <h4 class="field-label">200</h4>
2128 OK
2129 <a href="#String">String</a>
2130 <h4 class="field-label">400</h4>
2131 Bad Request
2132 <a href="#ErrorMessage">ErrorMessage</a>
2133 <h4 class="field-label">401</h4>
2134 Unauthorized
2135 <a href="#ErrorMessage">ErrorMessage</a>
2136 <h4 class="field-label">403</h4>
2137 Forbidden
2138 <a href="#ErrorMessage">ErrorMessage</a>
2139 <h4 class="field-label">404</h4>
2140 Not Found
2141 <a href="#ErrorMessage">ErrorMessage</a>
2142 <h4 class="field-label">500</h4>
2143 Internal Server Error
2144 <a href="#ErrorMessage">ErrorMessage</a>
2145 </div> <!-- method -->
2146 <hr/>
2147 <div class="method"><a name="getSchemas"/>
2148 <div class="method-path">
2149 <a class="up" href="#__Methods">Up</a>
2150 <pre class="get"><code class="huge"><span class="http-method">get</span> /schemas</code></pre></div>
2151 <div class="method-summary">Get a list of all schemas. (<span class="nickname">getSchemas</span>)</div>
2152 <div class="method-notes">Get a list of all schemas.</div>
2153
2154
2155
2156
2157 <h3 class="field-label">Request headers</h3>
2158 <div class="field-items">
2159 <div class="param">Accept (required)</div>
2160
2161 <div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: application/json </div>
2162
2163 </div> <!-- field-items -->
2164
2165 <h3 class="field-label">Query parameters</h3>
2166 <div class="field-items">
2167 <div class="param">domain (optional)</div>
2168
2169 <div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; default: null </div><div class="param">offset (optional)</div>
2170
2171 <div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Pagination offset. default: 0 </div><div class="param">limit (optional)</div>
2172
2173 <div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; Result limiter. default: 500 </div>
2174 </div> <!-- field-items -->
2175
2176
2177 <h3 class="field-label">Return type</h3>
2178 <div class="return-type">
2179 <a href="#SchemaList">SchemaList</a>
2180
2181 </div>
2182
2183 <!--Todo: process Response Object and its headers, schema, examples -->
2184
2185 <h3 class="field-label">Example data</h3>
2186 <div class="example-data-content-type">Content-Type: application/json</div>
2187 <pre class="example"><code>{
2188 "next" : {
2189 "href" : "href"
2190 },
2191 "last" : {
2192 "href" : "href"
2193 },
2194 "prev" : {
2195 "href" : "href"
2196 },
2197 "self" : {
2198 "href" : "href"
2199 },
2200 "totalCount" : 0,
2201 "items" : [ {
2202 "domain" : [ "domain", "domain" ],
2203 "name" : "name",
2204 "content" : {
2205 "href" : "href"
2206 },
2207 "revision" : "revision"
2208 }, {
2209 "domain" : [ "domain", "domain" ],
2210 "name" : "name",
2211 "content" : {
2212 "href" : "href"
2213 },
2214 "revision" : "revision"
2215 } ],
2216 "first" : {
2217 "href" : "href"
2218 }
2219}</code></pre>
2220 <h3 class="field-label">Example data</h3>
2221 <div class="example-data-content-type">Content-Type: application/problem+json</div>
2222 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
2223 <h3 class="field-label">Example data</h3>
2224 <div class="example-data-content-type">Content-Type: application/problem+json</div>
2225 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
2226 <h3 class="field-label">Example data</h3>
2227 <div class="example-data-content-type">Content-Type: application/problem+json</div>
2228 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
2229 <h3 class="field-label">Example data</h3>
2230 <div class="example-data-content-type">Content-Type: application/problem+json</div>
2231 <pre class="example"><code>Custom MIME type example not yet supported: application/problem+json</code></pre>
2232
2233 <h3 class="field-label">Produces</h3>
2234 This API call produces the following media types according to the <span class="header">Accept</span> request header;
2235 the media type will be conveyed by the <span class="header">Content-Type</span> response header.
2236 <ul>
2237 <li><code>application/json</code></li>
2238 <li><code>application/problem+json</code></li>
2239 </ul>
2240
2241 <h3 class="field-label">Responses</h3>
2242 <h4 class="field-label">200</h4>
2243 OK
2244 <a href="#SchemaList">SchemaList</a>
2245 <h4 class="field-label">400</h4>
2246 Bad Request
2247 <a href="#ErrorMessage">ErrorMessage</a>
2248 <h4 class="field-label">401</h4>
2249 Unauthorized
2250 <a href="#ErrorMessage">ErrorMessage</a>
2251 <h4 class="field-label">403</h4>
2252 Forbidden
2253 <a href="#ErrorMessage">ErrorMessage</a>
2254 <h4 class="field-label">500</h4>
2255 Internal Server Error
2256 <a href="#ErrorMessage">ErrorMessage</a>
2257 </div> <!-- method -->
2258 <hr/>
2259
2260 <h2><a name="__Models">Models</a></h2>
2261 [ Jump to <a href="#__Methods">Methods</a> ]
2262
2263 <h3>Table of Contents</h3>
2264 <ol>
2265 <li><a href="#Classifier"><code>Classifier</code> - Classifier</a></li>
2266 <li><a href="#Collection"><code>Collection</code> - </a></li>
2267 <li><a href="#CollectionResponse"><code>CollectionResponse</code> - </a></li>
2268 <li><a href="#CollectionResponse_criteria"><code>CollectionResponse_criteria</code> - </a></li>
2269 <li><a href="#Collections"><code>Collections</code> - Collections</a></li>
2270 <li><a href="#Decorator"><code>Decorator</code> - Decorator</a></li>
2271 <li><a href="#Domains"><code>Domains</code> - Domains</a></li>
2272 <li><a href="#Domains_items_inner"><code>Domains_items_inner</code> - </a></li>
2273 <li><a href="#DynamicSelection"><code>DynamicSelection</code> - </a></li>
2274 <li><a href="#DynamicSelection_resourceQuery"><code>DynamicSelection_resourceQuery</code> - </a></li>
2275 <li><a href="#EntitiesResponseMessage"><code>EntitiesResponseMessage</code> - Entities</a></li>
2276 <li><a href="#EntityTypes"><code>EntityTypes</code> - EntityTypes</a></li>
2277 <li><a href="#EntityTypes_items_inner"><code>EntityTypes_items_inner</code> - </a></li>
2278 <li><a href="#ErrorMessage"><code>ErrorMessage</code> - Error</a></li>
2279 <li><a href="#Href"><code>Href</code> - Href</a></li>
2280 <li><a href="#QueryMessage"><code>QueryMessage</code> - Query</a></li>
2281 <li><a href="#RelationshipTypes"><code>RelationshipTypes</code> - RelationshipTypes</a></li>
2282 <li><a href="#RelationshipTypes_items_inner"><code>RelationshipTypes_items_inner</code> - </a></li>
2283 <li><a href="#RelationshipsResponseMessage"><code>RelationshipsResponseMessage</code> - Relationships</a></li>
2284 <li><a href="#Schema"><code>Schema</code> - Schema</a></li>
2285 <li><a href="#SchemaList"><code>SchemaList</code> - Schemas</a></li>
2286 <li><a href="#StaticSelection"><code>StaticSelection</code> - </a></li>
2287 <li><a href="#TopologySelection"><code>TopologySelection</code> - </a></li>
2288 </ol>
2289
2290 <div class="model">
2291 <h3><a name="Classifier"><code>Classifier</code> - Classifier</a> <a class="up" href="#__Models">Up</a></h3>
2292 <div class='model-description'></div>
2293 <div class="field-items">
2294 <div class="param">operation (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
2295 <div class="param-enum-header">Enum:</div>
2296 <div class="param-enum">merge</div><div class="param-enum">delete</div>
2297<div class="param">classifier (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> </div>
2298<div class="param">entityIds (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> </div>
2299<div class="param">relationshipIds (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> </div>
2300 </div> <!-- field-items -->
2301 </div>
2302 <div class="model">
2303 <h3><a name="Collection"><code>Collection</code> - </a> <a class="up" href="#__Models">Up</a></h3>
2304 <div class='model-description'></div>
2305 <div class="field-items">
2306 <div class="param">collectionName (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
2307<div class="param">criteria (optional)</div><div class="param-desc"><span class="param-type"><a href="#TopologySelection">TopologySelection</a></span> </div>
2308 </div> <!-- field-items -->
2309 </div>
2310 <div class="model">
2311 <h3><a name="CollectionResponse"><code>CollectionResponse</code> - </a> <a class="up" href="#__Models">Up</a></h3>
2312 <div class='model-description'></div>
2313 <div class="field-items">
2314 <div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
2315<div class="param">collectionName (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
2316<div class="param">criteria (optional)</div><div class="param-desc"><span class="param-type"><a href="#CollectionResponse_criteria">CollectionResponse_criteria</a></span> </div>
2317 </div> <!-- field-items -->
2318 </div>
2319 <div class="model">
2320 <h3><a name="CollectionResponse_criteria"><code>CollectionResponse_criteria</code> - </a> <a class="up" href="#__Models">Up</a></h3>
2321 <div class='model-description'></div>
2322 <div class="field-items">
2323 <div class="param">resourceInstances (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> </div>
2324<div class="param">resourceQuery (optional)</div><div class="param-desc"><span class="param-type"><a href="#DynamicSelection_resourceQuery">DynamicSelection_resourceQuery</a></span> </div>
2325 </div> <!-- field-items -->
2326 </div>
2327 <div class="model">
2328 <h3><a name="Collections"><code>Collections</code> - Collections</a> <a class="up" href="#__Models">Up</a></h3>
2329 <div class='model-description'></div>
2330 <div class="field-items">
2331 <div class="param">items (optional)</div><div class="param-desc"><span class="param-type"><a href="#CollectionResponse">array[CollectionResponse]</a></span> </div>
2332<div class="param">self (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2333<div class="param">first (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2334<div class="param">prev (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2335<div class="param">next (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2336<div class="param">last (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2337<div class="param">totalCount (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> </div>
2338 </div> <!-- field-items -->
2339 </div>
2340 <div class="model">
2341 <h3><a name="Decorator"><code>Decorator</code> - Decorator</a> <a class="up" href="#__Models">Up</a></h3>
2342 <div class='model-description'></div>
2343 <div class="field-items">
2344 <div class="param">operation (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
2345 <div class="param-enum-header">Enum:</div>
2346 <div class="param-enum">merge</div><div class="param-enum">delete</div>
2347<div class="param">decorators (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">map[String, String]</a></span> </div>
2348<div class="param">entityIds (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> </div>
2349<div class="param">relationshipIds (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> </div>
2350 </div> <!-- field-items -->
2351 </div>
2352 <div class="model">
2353 <h3><a name="Domains"><code>Domains</code> - Domains</a> <a class="up" href="#__Models">Up</a></h3>
2354 <div class='model-description'></div>
2355 <div class="field-items">
2356 <div class="param">items (optional)</div><div class="param-desc"><span class="param-type"><a href="#Domains_items_inner">array[Domains_items_inner]</a></span> </div>
2357<div class="param">self (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2358<div class="param">first (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2359<div class="param">prev (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2360<div class="param">next (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2361<div class="param">last (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2362<div class="param">totalCount (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> </div>
2363 </div> <!-- field-items -->
2364 </div>
2365 <div class="model">
2366 <h3><a name="Domains_items_inner"><code>Domains_items_inner</code> - </a> <a class="up" href="#__Models">Up</a></h3>
2367 <div class='model-description'></div>
2368 <div class="field-items">
2369 <div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
2370<div class="param">entityTypes (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2371<div class="param">relationshipTypes (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2372 </div> <!-- field-items -->
2373 </div>
2374 <div class="model">
2375 <h3><a name="DynamicSelection"><code>DynamicSelection</code> - </a> <a class="up" href="#__Models">Up</a></h3>
2376 <div class='model-description'></div>
2377 <div class="field-items">
2378 <div class="param">resourceQuery (optional)</div><div class="param-desc"><span class="param-type"><a href="#DynamicSelection_resourceQuery">DynamicSelection_resourceQuery</a></span> </div>
2379 </div> <!-- field-items -->
2380 </div>
2381 <div class="model">
2382 <h3><a name="DynamicSelection_resourceQuery"><code>DynamicSelection_resourceQuery</code> - </a> <a class="up" href="#__Models">Up</a></h3>
2383 <div class='model-description'></div>
2384 <div class="field-items">
2385 <div class="param">url </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
2386<div class="param">method (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
2387<div class="param">queryParams (optional)</div><div class="param-desc"><span class="param-type"><a href="#">Object</a></span> </div>
2388<div class="param">requestBody (optional)</div><div class="param-desc"><span class="param-type"><a href="#">Object</a></span> </div>
2389 </div> <!-- field-items -->
2390 </div>
2391 <div class="model">
2392 <h3><a name="EntitiesResponseMessage"><code>EntitiesResponseMessage</code> - Entities</a> <a class="up" href="#__Models">Up</a></h3>
2393 <div class='model-description'></div>
2394 <div class="field-items">
2395 <div class="param">items (optional)</div><div class="param-desc"><span class="param-type"><a href="#object">array[Object]</a></span> </div>
2396<div class="param">self (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2397<div class="param">first (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2398<div class="param">prev (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2399<div class="param">next (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2400<div class="param">last (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2401<div class="param">totalCount (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> </div>
2402 </div> <!-- field-items -->
2403 </div>
2404 <div class="model">
2405 <h3><a name="EntityTypes"><code>EntityTypes</code> - EntityTypes</a> <a class="up" href="#__Models">Up</a></h3>
2406 <div class='model-description'></div>
2407 <div class="field-items">
2408 <div class="param">items (optional)</div><div class="param-desc"><span class="param-type"><a href="#EntityTypes_items_inner">array[EntityTypes_items_inner]</a></span> </div>
2409<div class="param">self (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2410<div class="param">first (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2411<div class="param">prev (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2412<div class="param">next (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2413<div class="param">last (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2414<div class="param">totalCount (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> </div>
2415 </div> <!-- field-items -->
2416 </div>
2417 <div class="model">
2418 <h3><a name="EntityTypes_items_inner"><code>EntityTypes_items_inner</code> - </a> <a class="up" href="#__Models">Up</a></h3>
2419 <div class='model-description'></div>
2420 <div class="field-items">
2421 <div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
2422<div class="param">entities (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2423 </div> <!-- field-items -->
2424 </div>
2425 <div class="model">
2426 <h3><a name="ErrorMessage"><code>ErrorMessage</code> - Error</a> <a class="up" href="#__Models">Up</a></h3>
2427 <div class='model-description'></div>
2428 <div class="field-items">
2429 <div class="param">status (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
2430<div class="param">message (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
2431<div class="param">details (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
2432 </div> <!-- field-items -->
2433 </div>
2434 <div class="model">
2435 <h3><a name="Href"><code>Href</code> - Href</a> <a class="up" href="#__Models">Up</a></h3>
2436 <div class='model-description'></div>
2437 <div class="field-items">
2438 <div class="param">href (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> format: uri-template</div>
2439 </div> <!-- field-items -->
2440 </div>
2441 <div class="model">
2442 <h3><a name="QueryMessage"><code>QueryMessage</code> - Query</a> <a class="up" href="#__Models">Up</a></h3>
2443 <div class='model-description'></div>
2444 <div class="field-items">
2445 <div class="param">query (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
2446 </div> <!-- field-items -->
2447 </div>
2448 <div class="model">
2449 <h3><a name="RelationshipTypes"><code>RelationshipTypes</code> - RelationshipTypes</a> <a class="up" href="#__Models">Up</a></h3>
2450 <div class='model-description'></div>
2451 <div class="field-items">
2452 <div class="param">items (optional)</div><div class="param-desc"><span class="param-type"><a href="#RelationshipTypes_items_inner">array[RelationshipTypes_items_inner]</a></span> </div>
2453<div class="param">self (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2454<div class="param">first (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2455<div class="param">prev (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2456<div class="param">next (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2457<div class="param">last (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2458<div class="param">totalCount (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> </div>
2459 </div> <!-- field-items -->
2460 </div>
2461 <div class="model">
2462 <h3><a name="RelationshipTypes_items_inner"><code>RelationshipTypes_items_inner</code> - </a> <a class="up" href="#__Models">Up</a></h3>
2463 <div class='model-description'></div>
2464 <div class="field-items">
2465 <div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
2466<div class="param">relationships (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2467 </div> <!-- field-items -->
2468 </div>
2469 <div class="model">
2470 <h3><a name="RelationshipsResponseMessage"><code>RelationshipsResponseMessage</code> - Relationships</a> <a class="up" href="#__Models">Up</a></h3>
2471 <div class='model-description'></div>
2472 <div class="field-items">
2473 <div class="param">items (optional)</div><div class="param-desc"><span class="param-type"><a href="#object">array[Object]</a></span> </div>
2474<div class="param">self (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2475<div class="param">first (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2476<div class="param">prev (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2477<div class="param">next (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2478<div class="param">last (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2479<div class="param">totalCount (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> </div>
2480 </div> <!-- field-items -->
2481 </div>
2482 <div class="model">
2483 <h3><a name="Schema"><code>Schema</code> - Schema</a> <a class="up" href="#__Models">Up</a></h3>
2484 <div class='model-description'></div>
2485 <div class="field-items">
2486 <div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
2487<div class="param">domain (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> </div>
2488<div class="param">revision (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
2489<div class="param">content (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2490 </div> <!-- field-items -->
2491 </div>
2492 <div class="model">
2493 <h3><a name="SchemaList"><code>SchemaList</code> - Schemas</a> <a class="up" href="#__Models">Up</a></h3>
2494 <div class='model-description'></div>
2495 <div class="field-items">
2496 <div class="param">items (optional)</div><div class="param-desc"><span class="param-type"><a href="#Schema">array[Schema]</a></span> </div>
2497<div class="param">self (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2498<div class="param">first (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2499<div class="param">prev (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2500<div class="param">next (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2501<div class="param">last (optional)</div><div class="param-desc"><span class="param-type"><a href="#Href">Href</a></span> </div>
2502<div class="param">totalCount (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> </div>
2503 </div> <!-- field-items -->
2504 </div>
2505 <div class="model">
2506 <h3><a name="StaticSelection"><code>StaticSelection</code> - </a> <a class="up" href="#__Models">Up</a></h3>
2507 <div class='model-description'></div>
2508 <div class="field-items">
2509 <div class="param">resourceInstances (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> </div>
2510 </div> <!-- field-items -->
2511 </div>
2512 <div class="model">
2513 <h3><a name="TopologySelection"><code>TopologySelection</code> - </a> <a class="up" href="#__Models">Up</a></h3>
2514 <div class='model-description'></div>
2515 <div class="field-items">
2516 <div class="param">resourceInstances (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> </div>
2517<div class="param">resourceQuery (optional)</div><div class="param-desc"><span class="param-type"><a href="#DynamicSelection_resourceQuery">DynamicSelection_resourceQuery</a></span> </div>
2518 </div> <!-- field-items -->
2519 </div>
2520 </body>
2521</html>