diff options
Diffstat (limited to 'api/lsoapi-rest.html')
| -rw-r--r-- | api/lsoapi-rest.html | 1385 |
1 files changed, 1385 insertions, 0 deletions
diff --git a/api/lsoapi-rest.html b/api/lsoapi-rest.html new file mode 100644 index 0000000..4d66593 --- /dev/null +++ b/api/lsoapi-rest.html @@ -0,0 +1,1385 @@ +<!DOCTYPE HTML><html><head><title>lsoapi API documentation</title><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="generator" content="https://github.com/kevinrenskers/raml2html 2.0.2"><link rel="stylesheet" href="https://netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.1/styles/default.min.css"><script type="text/javascript" src="https://code.jquery.com/jquery-1.11.0.min.js"></script><script type="text/javascript" src="https://netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.1/highlight.min.js"></script><script type="text/javascript"> + $(document).ready(function() { + $('.page-header pre code, .top-resource-description pre code').each(function(i, block) { + hljs.highlightBlock(block); + }); + + $('[data-toggle]').click(function() { + var selector = $(this).data('target') + ' pre code'; + $(selector).each(function(i, block) { + hljs.highlightBlock(block); + }); + }); + + // open modal on hashes like #_action_get + $(window).bind('hashchange', function(e) { + var anchor_id = document.location.hash.substr(1); //strip # + var element = $('#' + anchor_id); + + // do we have such element + is it a modal? --> show it + if (element.length && element.hasClass('modal')) { + element.modal('show'); + } + }); + + // execute hashchange on first page load + $(window).trigger('hashchange'); + + // remove url fragment on modal hide + $('.modal').on('hidden.bs.modal', function() { + if(history && history.replaceState) { + history.replaceState({}, '', '#'); + } + }); + }); + </script><style> + .hljs { + background: transparent; + } + .parent { + color: #999; + } + .list-group-item > .badge { + float: none; + margin-right: 6px; + } + .panel-title > .methods { + float: right; + } + .badge { + border-radius: 0; + text-transform: uppercase; + width: 70px; + font-weight: normal; + color: #f3f3f6; + line-height: normal; + } + .badge_get { + background-color: #63a8e2; + } + .badge_post { + background-color: #6cbd7d; + } + .badge_put { + background-color: #22bac4; + } + .badge_delete { + background-color: #d26460; + } + .badge_patch { + background-color: #ccc444; + } + .list-group, .panel-group { + margin-bottom: 0; + } + .panel-group .panel+.panel-white { + margin-top: 0; + } + .panel-group .panel-white { + border-bottom: 1px solid #F5F5F5; + border-radius: 0; + } + .panel-white:last-child { + border-bottom-color: white; + -webkit-box-shadow: none; + box-shadow: none; + } + .panel-white .panel-heading { + background: white; + } + .tab-pane ul { + padding-left: 2em; + } + .tab-pane h2 { + font-size: 1.2em; + padding-bottom: 4px; + border-bottom: 1px solid #ddd; + } + .tab-pane h3 { + font-size: 1.1em; + } + .tab-content { + border-left: 1px solid #ddd; + border-right: 1px solid #ddd; + border-bottom: 1px solid #ddd; + padding: 10px; + } + #sidebar { + margin-top: 30px; + padding-right: 5px; + overflow: auto; + height: 90%; + } + .top-resource-description { + border-bottom: 1px solid #ddd; + background: #fcfcfc; + padding: 15px 15px 0 15px; + margin: -15px -15px 10px -15px; + } + .resource-description { + border-bottom: 1px solid #fcfcfc; + background: #fcfcfc; + padding: 15px 15px 0 15px; + margin: -15px -15px 10px -15px; + } + .resource-description p:last-child { + margin: 0; + } + .list-group .badge { + float: left; + } + .method_description { + margin-left: 85px; + } + .method_description p:last-child { + margin: 0; + } + .list-group-item { + cursor: pointer; + } + .list-group-item:hover { + background-color: #f5f5f5; + } + </style></head><body data-spy="scroll" data-target="#sidebar"><div class="container"><div class="row"><div class="col-md-9" role="main"><div class="page-header"><h1>lsoapi API documentation <small>version v1</small></h1><p>http://lsoapi-server</p></div><div class="panel panel-default"><div class="panel-heading"><h3 id="svcmgr_webapi" class="panel-title">CRUD Instances of MEF Defined Services</h3></div><div class="panel-body"><div class="top-resource-description"><p>CRUD Instances of MEF Defined Services</p></div><div class="panel-group"><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_svcmgr_webapi_svc_epl"><span class="parent">/svcmgr/webapi</span>/svc/epl</a> <span class="methods"><a href="#svcmgr_webapi_svc_epl_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_svcmgr_webapi_svc_epl" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>CRUD Instances MEF EPL Service, returns JSON representing created EPL instance</p></div><div class="list-group"><div onclick="window.location.href = '#svcmgr_webapi_svc_epl_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Create an new EPL instance</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="svcmgr_webapi_svc_epl_post"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/svcmgr/webapi</span>/svc/epl</h4></div><div class="modal-body"><div class="alert alert-info"><p>Create an new EPL instance</p></div><ul class="nav nav-tabs"><li class="active"><a href="#svcmgr_webapi_svc_epl_post_request" data-toggle="tab">Request</a></li><li><a href="#svcmgr_webapi_svc_epl_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="svcmgr_webapi_svc_epl_post_request"><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{ + "id": { + "required": true, + "type": "string" + }, + "numCustLocations": { + "required": true, + "type": "long" + }, + "custAddressList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "uniHostMacList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "uniHostIpList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "cos": { + "required": true, + "type": "long" + }, + "evcId": { + "required": true, + "type": "long" + } +} +</code></pre><p><strong>Example</strong>:</p><pre><code>{ + "id": "epl-1", + "numCustLocations": 2, + "custAddressList": [ + "1111 MEF Dr, Honolulu HI, USA", + "2222 UNI Dr, Boston MA, MAS" + ], + "uniHostMacList": [ + "00:B0:95:9d:68:16", + "00:A0:C9:14:C8:29" + ] + "uniHostIpList": [ + "192.168.1.10", + "192.168.1.11"s + ], + "cos": "gold", + "evcId": "evc-1", +} +</code></pre></div><div class="tab-pane" id="svcmgr_webapi_svc_epl_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>JSON representing created EPL instance</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{ + "id": { + "required": true, + "type": "string" + }, + "numCustLocations": { + "required": true, + "type": "long" + }, + "custAddressList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "uniHostMacList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "uniHostIpList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "cos": { + "required": true, + "type": "long" + }, + "evcId": { + "required": true, + "type": "long" + } +} +</code></pre><p><strong>Example</strong>:</p><pre><code>{ + "id": "epl-1", + "numCustLocations": 2, + "custAddressList": [ + "1111 MEF Dr, Honolulu HI, USA", + "2222 UNI Dr, Boston MA, MAS" + ], + "uniHostMacList": [ + "00:B0:95:9d:68:16", + "00:A0:C9:14:C8:29" + ] + "uniHostIpList": [ + "192.168.1.10", + "192.168.1.11"s + ], + "cos": "gold", + "evcId": "evc-1", +} +</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_svcmgr_webapi_svc_epl__eplid_"><span class="parent">/svcmgr/webapi/svc/epl</span>/{eplid}</a> <span class="methods"><a href="#svcmgr_webapi_svc_epl__eplid__put"><span class="badge badge_put">put</span></a> <a href="#svcmgr_webapi_svc_epl__eplid__get"><span class="badge badge_get">get</span></a> <a href="#svcmgr_webapi_svc_epl__eplid__delete"><span class="badge badge_delete">delete</span></a></span></h4></div><div id="panel_svcmgr_webapi_svc_epl__eplid_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#svcmgr_webapi_svc_epl__eplid__put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Modify an existing EPL instance</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#svcmgr_webapi_svc_epl__eplid__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Query an existing EPL instance</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#svcmgr_webapi_svc_epl__eplid__delete'" class="list-group-item"><span class="badge badge_delete">delete</span><div class="method_description"><p>delete an existing EPL instance</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="svcmgr_webapi_svc_epl__eplid__put"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent">/svcmgr/webapi/svc/epl</span>/{eplid}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Modify an existing EPL instance</p></div><ul class="nav nav-tabs"><li class="active"><a href="#svcmgr_webapi_svc_epl__eplid__put_request" data-toggle="tab">Request</a></li><li><a href="#svcmgr_webapi_svc_epl__eplid__put_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="svcmgr_webapi_svc_epl__eplid__put_request"><h3>URI Parameters</h3><ul><li><strong>eplid</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{ + "id": { + "required": true, + "type": "string" + }, + "numCustLocations": { + "required": true, + "type": "long" + }, + "custAddressList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "uniHostMacList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "uniHostIpList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "cos": { + "required": true, + "type": "long" + }, + "evcId": { + "required": true, + "type": "long" + } +} +</code></pre><p><strong>Example</strong>:</p><pre><code>{ + "id": "epl-1", + "numCustLocations": 2, + "custAddressList": [ + "1111 MEF Dr, Honolulu HI, USA", + "2222 UNI Dr, Boston MA, MAS" + ], + "uniHostMacList": [ + "00:B0:95:9d:68:16", + "00:A0:C9:14:C8:29" + ] + "uniHostIpList": [ + "192.168.1.10", + "192.168.1.11"s + ], + "cos": "gold", + "evcId": "evc-1", +} +</code></pre></div><div class="tab-pane" id="svcmgr_webapi_svc_epl__eplid__put_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>JSON representing modified EPL instance</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{ + "id": { + "required": true, + "type": "string" + }, + "numCustLocations": { + "required": true, + "type": "long" + }, + "custAddressList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "uniHostMacList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "uniHostIpList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "cos": { + "required": true, + "type": "long" + }, + "evcId": { + "required": true, + "type": "long" + } +} +</code></pre><p><strong>Example</strong>:</p><pre><code>{ + "id": "epl-1", + "numCustLocations": 2, + "custAddressList": [ + "1111 MEF Dr, Honolulu HI, USA", + "2222 UNI Dr, Boston MA, MAS" + ], + "uniHostMacList": [ + "00:B0:95:9d:68:16", + "00:A0:C9:14:C8:29" + ] + "uniHostIpList": [ + "192.168.1.10", + "192.168.1.11"s + ], + "cos": "gold", + "evcId": "evc-1", +} +</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="svcmgr_webapi_svc_epl__eplid__get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/svcmgr/webapi/svc/epl</span>/{eplid}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Query an existing EPL instance</p></div><ul class="nav nav-tabs"><li class="active"><a href="#svcmgr_webapi_svc_epl__eplid__get_request" data-toggle="tab">Request</a></li><li><a href="#svcmgr_webapi_svc_epl__eplid__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="svcmgr_webapi_svc_epl__eplid__get_request"><h3>URI Parameters</h3><ul><li><strong>eplid</strong>: <em>required (string)</em></li></ul></div><div class="tab-pane" id="svcmgr_webapi_svc_epl__eplid__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>JSON representing the queried EPL instance</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{ + "id": { + "required": true, + "type": "string" + }, + "numCustLocations": { + "required": true, + "type": "long" + }, + "custAddressList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "uniHostMacList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "uniHostIpList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "cos": { + "required": true, + "type": "long" + }, + "evcId": { + "required": true, + "type": "long" + } +} +</code></pre><p><strong>Example</strong>:</p><pre><code>{ + "id": "epl-1", + "numCustLocations": 2, + "custAddressList": [ + "1111 MEF Dr, Honolulu HI, USA", + "2222 UNI Dr, Boston MA, MAS" + ], + "uniHostMacList": [ + "00:B0:95:9d:68:16", + "00:A0:C9:14:C8:29" + ] + "uniHostIpList": [ + "192.168.1.10", + "192.168.1.11"s + ], + "cos": "gold", + "evcId": "evc-1", +} +</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="svcmgr_webapi_svc_epl__eplid__delete"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_delete">delete</span> <span class="parent">/svcmgr/webapi/svc/epl</span>/{eplid}</h4></div><div class="modal-body"><div class="alert alert-info"><p>delete an existing EPL instance</p></div><ul class="nav nav-tabs"><li class="active"><a href="#svcmgr_webapi_svc_epl__eplid__delete_request" data-toggle="tab">Request</a></li><li><a href="#svcmgr_webapi_svc_epl__eplid__delete_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="svcmgr_webapi_svc_epl__eplid__delete_request"><h3>URI Parameters</h3><ul><li><strong>eplid</strong>: <em>required (string)</em></li></ul></div><div class="tab-pane" id="svcmgr_webapi_svc_epl__eplid__delete_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>JSON representing deleted EPL instance</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{ + "id": { + "required": true, + "type": "string" + }, + "numCustLocations": { + "required": true, + "type": "long" + }, + "custAddressList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "uniHostMacList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "uniHostIpList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "cos": { + "required": true, + "type": "long" + }, + "evcId": { + "required": true, + "type": "long" + } +} +</code></pre><p><strong>Example</strong>:</p><pre><code>{ + "id": "epl-1", + "numCustLocations": 2, + "custAddressList": [ + "1111 MEF Dr, Honolulu HI, USA", + "2222 UNI Dr, Boston MA, MAS" + ], + "uniHostMacList": [ + "00:B0:95:9d:68:16", + "00:A0:C9:14:C8:29" + ] + "uniHostIpList": [ + "192.168.1.10", + "192.168.1.11"s + ], + "cos": "gold", + "evcId": "evc-1", +} +</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_svcmgr_webapi_svc_epl_list"><span class="parent">/svcmgr/webapi/svc/epl</span>/list</a> <span class="methods"><a href="#svcmgr_webapi_svc_epl_list_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_svcmgr_webapi_svc_epl_list" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Get a list of all EPL instances</p></div><div class="list-group"><div onclick="window.location.href = '#svcmgr_webapi_svc_epl_list_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Query a list of all existing EPL instances</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="svcmgr_webapi_svc_epl_list_get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/svcmgr/webapi/svc/epl</span>/list</h4></div><div class="modal-body"><div class="alert alert-info"><p>Query a list of all existing EPL instances</p></div><ul class="nav nav-tabs"></ul><div class="tab-content"></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="evcmgr_webapi" class="panel-title">CRUD MEF EVC Instances</h3></div><div class="panel-body"><div class="top-resource-description"><p>CRUD MEF EVC Instances</p></div><div class="panel-group"><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_evcmgr_webapi"><span class="parent"></span>/evcmgr/webapi</a> <span class="methods"><a href="#evcmgr_webapi_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_evcmgr_webapi" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#evcmgr_webapi_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Create an new EVC instance</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="evcmgr_webapi_post"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent"></span>/evcmgr/webapi</h4></div><div class="modal-body"><div class="alert alert-info"><p>Create an new EVC instance</p></div><ul class="nav nav-tabs"><li class="active"><a href="#evcmgr_webapi_post_request" data-toggle="tab">Request</a></li><li><a href="#evcmgr_webapi_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="evcmgr_webapi_post_request"><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{ + "id": { + "required": true, + "type": "string" + }, + "evcType": { + "required": true, + "type": "string", + "enum" : [ + "POINT_TO_POINT", + "MULTIPOINT_TO_MULTIPOINT", + "ROOTED_MULTIPOINT" + ] + }, + "maxUnis": { + "required": true, + "type": "long" + }, + "unicastFrameDelivery": { + "required": true, + "type": "string", + "enum" : [ + "DISCARD", + "UNCONDITIONAL", + "CONDITIONAL" + ] + }, + "multicastFrameDelivery": { + "required": true, + "type": "string", + "enum" : [ + "DISCARD", + "UNCONDITIONAL", + "CONDITIONAL" + ] + }, + "broadcastFrameDelivery": { + "required": true, + "type": "string", + "enum" : [ + "DISCARD", + "UNCONDITIONAL", + "CONDITIONAL" + ] + }, + "uniIdList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "uniIpList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "uniMacList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "ceVLanIdPreservation": { + "required": true, + "type": "boolean" + }, + "ceVlanCosPreservation": { + "required": true, + "type": "boolean" + }, + "cosId": { + "required": true, + "type": "string" + }, + "evcMaxSvcFrameSize": { + "required": true, + "type": "long" + }, + "oneWayAvailability": { + "required": true, + "type": "double" + }, + "oneWayFrameDelay": { + "required": true, + "type": "double" + }, + "oneWayFrameLossRatio": { + "required": true, + "type": "double" + } +} +</code></pre><p><strong>Example</strong>:</p><pre><code>{ + "id": "evc-1", + "evcType": "POINT_TO_POINT", + "maxUnis": 2, + "unicastFrameDelivery": "UNCONDITIONAL" + "multicastFrameDelivery": "UNCONDITIONAL", + "broadcastFrameDelivery": "UNCONDITIONAL", + "uniIdList": [ + "UNI-1", + "UNI-2" + ], + "uniIpList": [ + "192.168.1.1", + "192.168.1.2" + ], + "uniMacList": [ + "11:00:11:11:11:11", + "11:00:22:22:22:22" + ], + "ceVLanIdPreservation": true, + "ceVlanCosPreservation": true, + "cosId": "gold", + "evcMaxSvcFrameSize": 1600, + "oneWayAvailability": .99, + "oneWayFrameDelay": .32, + "oneWayFrameLossRatio": .01 +} +</code></pre></div><div class="tab-pane" id="evcmgr_webapi_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>JSON representing created EVC instance</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{ + "id": { + "required": true, + "type": "string" + }, + "evcType": { + "required": true, + "type": "string", + "enum" : [ + "POINT_TO_POINT", + "MULTIPOINT_TO_MULTIPOINT", + "ROOTED_MULTIPOINT" + ] + }, + "maxUnis": { + "required": true, + "type": "long" + }, + "unicastFrameDelivery": { + "required": true, + "type": "string", + "enum" : [ + "DISCARD", + "UNCONDITIONAL", + "CONDITIONAL" + ] + }, + "multicastFrameDelivery": { + "required": true, + "type": "string", + "enum" : [ + "DISCARD", + "UNCONDITIONAL", + "CONDITIONAL" + ] + }, + "broadcastFrameDelivery": { + "required": true, + "type": "string", + "enum" : [ + "DISCARD", + "UNCONDITIONAL", + "CONDITIONAL" + ] + }, + "uniIdList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "uniIpList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "uniMacList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "ceVLanIdPreservation": { + "required": true, + "type": "boolean" + }, + "ceVlanCosPreservation": { + "required": true, + "type": "boolean" + }, + "cosId": { + "required": true, + "type": "string" + }, + "evcMaxSvcFrameSize": { + "required": true, + "type": "long" + }, + "oneWayAvailability": { + "required": true, + "type": "double" + }, + "oneWayFrameDelay": { + "required": true, + "type": "double" + }, + "oneWayFrameLossRatio": { + "required": true, + "type": "double" + } +} +</code></pre><p><strong>Example</strong>:</p><pre><code>{ + "id": "evc-1", + "evcType": "POINT_TO_POINT", + "maxUnis": 2, + "unicastFrameDelivery": "UNCONDITIONAL" + "multicastFrameDelivery": "UNCONDITIONAL", + "broadcastFrameDelivery": "UNCONDITIONAL", + "uniIdList": [ + "UNI-1", + "UNI-2" + ], + "uniIpList": [ + "192.168.1.1", + "192.168.1.2" + ], + "uniMacList": [ + "11:00:11:11:11:11", + "11:00:22:22:22:22" + ], + "ceVLanIdPreservation": true, + "ceVlanCosPreservation": true, + "cosId": "gold", + "evcMaxSvcFrameSize": 1600, + "oneWayAvailability": .99, + "oneWayFrameDelay": .32, + "oneWayFrameLossRatio": .01 +} +</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_evcmgr_webapi__evcid_"><span class="parent">/evcmgr/webapi</span>/{evcid}</a> <span class="methods"><a href="#evcmgr_webapi__evcid__put"><span class="badge badge_put">put</span></a> <a href="#evcmgr_webapi__evcid__get"><span class="badge badge_get">get</span></a> <a href="#evcmgr_webapi__evcid__delete"><span class="badge badge_delete">delete</span></a></span></h4></div><div id="panel_evcmgr_webapi__evcid_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#evcmgr_webapi__evcid__put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Modify an existing EVC instance</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#evcmgr_webapi__evcid__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Query an existing EVC instance</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#evcmgr_webapi__evcid__delete'" class="list-group-item"><span class="badge badge_delete">delete</span><div class="method_description"><p>delete an existing EPL instance</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="evcmgr_webapi__evcid__put"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent">/evcmgr/webapi</span>/{evcid}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Modify an existing EVC instance</p></div><ul class="nav nav-tabs"><li class="active"><a href="#evcmgr_webapi__evcid__put_request" data-toggle="tab">Request</a></li><li><a href="#evcmgr_webapi__evcid__put_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="evcmgr_webapi__evcid__put_request"><h3>URI Parameters</h3><ul><li><strong>evcid</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{ + "id": { + "required": true, + "type": "string" + }, + "evcType": { + "required": true, + "type": "string", + "enum" : [ + "POINT_TO_POINT", + "MULTIPOINT_TO_MULTIPOINT", + "ROOTED_MULTIPOINT" + ] + }, + "maxUnis": { + "required": true, + "type": "long" + }, + "unicastFrameDelivery": { + "required": true, + "type": "string", + "enum" : [ + "DISCARD", + "UNCONDITIONAL", + "CONDITIONAL" + ] + }, + "multicastFrameDelivery": { + "required": true, + "type": "string", + "enum" : [ + "DISCARD", + "UNCONDITIONAL", + "CONDITIONAL" + ] + }, + "broadcastFrameDelivery": { + "required": true, + "type": "string", + "enum" : [ + "DISCARD", + "UNCONDITIONAL", + "CONDITIONAL" + ] + }, + "uniIdList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "uniIpList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "uniMacList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "ceVLanIdPreservation": { + "required": true, + "type": "boolean" + }, + "ceVlanCosPreservation": { + "required": true, + "type": "boolean" + }, + "cosId": { + "required": true, + "type": "string" + }, + "evcMaxSvcFrameSize": { + "required": true, + "type": "long" + }, + "oneWayAvailability": { + "required": true, + "type": "double" + }, + "oneWayFrameDelay": { + "required": true, + "type": "double" + }, + "oneWayFrameLossRatio": { + "required": true, + "type": "double" + } +} +</code></pre><p><strong>Example</strong>:</p><pre><code>{ + "id": "evc-1", + "evcType": "POINT_TO_POINT", + "maxUnis": 2, + "unicastFrameDelivery": "UNCONDITIONAL" + "multicastFrameDelivery": "UNCONDITIONAL", + "broadcastFrameDelivery": "UNCONDITIONAL", + "uniIdList": [ + "UNI-1", + "UNI-2" + ], + "uniIpList": [ + "192.168.1.1", + "192.168.1.2" + ], + "uniMacList": [ + "11:00:11:11:11:11", + "11:00:22:22:22:22" + ], + "ceVLanIdPreservation": true, + "ceVlanCosPreservation": true, + "cosId": "gold", + "evcMaxSvcFrameSize": 1600, + "oneWayAvailability": .99, + "oneWayFrameDelay": .32, + "oneWayFrameLossRatio": .01 +} +</code></pre></div><div class="tab-pane" id="evcmgr_webapi__evcid__put_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>JSON representing modified EVC instance</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{ + "id": { + "required": true, + "type": "string" + }, + "evcType": { + "required": true, + "type": "string", + "enum" : [ + "POINT_TO_POINT", + "MULTIPOINT_TO_MULTIPOINT", + "ROOTED_MULTIPOINT" + ] + }, + "maxUnis": { + "required": true, + "type": "long" + }, + "unicastFrameDelivery": { + "required": true, + "type": "string", + "enum" : [ + "DISCARD", + "UNCONDITIONAL", + "CONDITIONAL" + ] + }, + "multicastFrameDelivery": { + "required": true, + "type": "string", + "enum" : [ + "DISCARD", + "UNCONDITIONAL", + "CONDITIONAL" + ] + }, + "broadcastFrameDelivery": { + "required": true, + "type": "string", + "enum" : [ + "DISCARD", + "UNCONDITIONAL", + "CONDITIONAL" + ] + }, + "uniIdList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "uniIpList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "uniMacList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "ceVLanIdPreservation": { + "required": true, + "type": "boolean" + }, + "ceVlanCosPreservation": { + "required": true, + "type": "boolean" + }, + "cosId": { + "required": true, + "type": "string" + }, + "evcMaxSvcFrameSize": { + "required": true, + "type": "long" + }, + "oneWayAvailability": { + "required": true, + "type": "double" + }, + "oneWayFrameDelay": { + "required": true, + "type": "double" + }, + "oneWayFrameLossRatio": { + "required": true, + "type": "double" + } +} +</code></pre><p><strong>Example</strong>:</p><pre><code>{ + "id": "evc-1", + "evcType": "POINT_TO_POINT", + "maxUnis": 2, + "unicastFrameDelivery": "UNCONDITIONAL" + "multicastFrameDelivery": "UNCONDITIONAL", + "broadcastFrameDelivery": "UNCONDITIONAL", + "uniIdList": [ + "UNI-1", + "UNI-2" + ], + "uniIpList": [ + "192.168.1.1", + "192.168.1.2" + ], + "uniMacList": [ + "11:00:11:11:11:11", + "11:00:22:22:22:22" + ], + "ceVLanIdPreservation": true, + "ceVlanCosPreservation": true, + "cosId": "gold", + "evcMaxSvcFrameSize": 1600, + "oneWayAvailability": .99, + "oneWayFrameDelay": .32, + "oneWayFrameLossRatio": .01 +} +</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="evcmgr_webapi__evcid__get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/evcmgr/webapi</span>/{evcid}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Query an existing EVC instance</p></div><ul class="nav nav-tabs"><li class="active"><a href="#evcmgr_webapi__evcid__get_request" data-toggle="tab">Request</a></li><li><a href="#evcmgr_webapi__evcid__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="evcmgr_webapi__evcid__get_request"><h3>URI Parameters</h3><ul><li><strong>evcid</strong>: <em>required (string)</em></li></ul></div><div class="tab-pane" id="evcmgr_webapi__evcid__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>JSON representing the queried EPL instance</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{ + "id": { + "required": true, + "type": "string" + }, + "evcType": { + "required": true, + "type": "string", + "enum" : [ + "POINT_TO_POINT", + "MULTIPOINT_TO_MULTIPOINT", + "ROOTED_MULTIPOINT" + ] + }, + "maxUnis": { + "required": true, + "type": "long" + }, + "unicastFrameDelivery": { + "required": true, + "type": "string", + "enum" : [ + "DISCARD", + "UNCONDITIONAL", + "CONDITIONAL" + ] + }, + "multicastFrameDelivery": { + "required": true, + "type": "string", + "enum" : [ + "DISCARD", + "UNCONDITIONAL", + "CONDITIONAL" + ] + }, + "broadcastFrameDelivery": { + "required": true, + "type": "string", + "enum" : [ + "DISCARD", + "UNCONDITIONAL", + "CONDITIONAL" + ] + }, + "uniIdList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "uniIpList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "uniMacList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "ceVLanIdPreservation": { + "required": true, + "type": "boolean" + }, + "ceVlanCosPreservation": { + "required": true, + "type": "boolean" + }, + "cosId": { + "required": true, + "type": "string" + }, + "evcMaxSvcFrameSize": { + "required": true, + "type": "long" + }, + "oneWayAvailability": { + "required": true, + "type": "double" + }, + "oneWayFrameDelay": { + "required": true, + "type": "double" + }, + "oneWayFrameLossRatio": { + "required": true, + "type": "double" + } +} +</code></pre><p><strong>Example</strong>:</p><pre><code>{ + "id": "evc-1", + "evcType": "POINT_TO_POINT", + "maxUnis": 2, + "unicastFrameDelivery": "UNCONDITIONAL" + "multicastFrameDelivery": "UNCONDITIONAL", + "broadcastFrameDelivery": "UNCONDITIONAL", + "uniIdList": [ + "UNI-1", + "UNI-2" + ], + "uniIpList": [ + "192.168.1.1", + "192.168.1.2" + ], + "uniMacList": [ + "11:00:11:11:11:11", + "11:00:22:22:22:22" + ], + "ceVLanIdPreservation": true, + "ceVlanCosPreservation": true, + "cosId": "gold", + "evcMaxSvcFrameSize": 1600, + "oneWayAvailability": .99, + "oneWayFrameDelay": .32, + "oneWayFrameLossRatio": .01 +} +</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="evcmgr_webapi__evcid__delete"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_delete">delete</span> <span class="parent">/evcmgr/webapi</span>/{evcid}</h4></div><div class="modal-body"><div class="alert alert-info"><p>delete an existing EPL instance</p></div><ul class="nav nav-tabs"><li class="active"><a href="#evcmgr_webapi__evcid__delete_request" data-toggle="tab">Request</a></li><li><a href="#evcmgr_webapi__evcid__delete_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="evcmgr_webapi__evcid__delete_request"><h3>URI Parameters</h3><ul><li><strong>evcid</strong>: <em>required (string)</em></li></ul></div><div class="tab-pane" id="evcmgr_webapi__evcid__delete_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>JSON representing deleted EVC instance</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{ + "id": { + "required": true, + "type": "string" + }, + "evcType": { + "required": true, + "type": "string", + "enum" : [ + "POINT_TO_POINT", + "MULTIPOINT_TO_MULTIPOINT", + "ROOTED_MULTIPOINT" + ] + }, + "maxUnis": { + "required": true, + "type": "long" + }, + "unicastFrameDelivery": { + "required": true, + "type": "string", + "enum" : [ + "DISCARD", + "UNCONDITIONAL", + "CONDITIONAL" + ] + }, + "multicastFrameDelivery": { + "required": true, + "type": "string", + "enum" : [ + "DISCARD", + "UNCONDITIONAL", + "CONDITIONAL" + ] + }, + "broadcastFrameDelivery": { + "required": true, + "type": "string", + "enum" : [ + "DISCARD", + "UNCONDITIONAL", + "CONDITIONAL" + ] + }, + "uniIdList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "uniIpList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "uniMacList": { + "required": true, + "type": "array", + "items": { "type" : "string" }, + "uniqueItems": true + }, + "ceVLanIdPreservation": { + "required": true, + "type": "boolean" + }, + "ceVlanCosPreservation": { + "required": true, + "type": "boolean" + }, + "cosId": { + "required": true, + "type": "string" + }, + "evcMaxSvcFrameSize": { + "required": true, + "type": "long" + }, + "oneWayAvailability": { + "required": true, + "type": "double" + }, + "oneWayFrameDelay": { + "required": true, + "type": "double" + }, + "oneWayFrameLossRatio": { + "required": true, + "type": "double" + } +} +</code></pre><p><strong>Example</strong>:</p><pre><code>{ + "id": "evc-1", + "evcType": "POINT_TO_POINT", + "maxUnis": 2, + "unicastFrameDelivery": "UNCONDITIONAL" + "multicastFrameDelivery": "UNCONDITIONAL", + "broadcastFrameDelivery": "UNCONDITIONAL", + "uniIdList": [ + "UNI-1", + "UNI-2" + ], + "uniIpList": [ + "192.168.1.1", + "192.168.1.2" + ], + "uniMacList": [ + "11:00:11:11:11:11", + "11:00:22:22:22:22" + ], + "ceVLanIdPreservation": true, + "ceVlanCosPreservation": true, + "cosId": "gold", + "evcMaxSvcFrameSize": 1600, + "oneWayAvailability": .99, + "oneWayFrameDelay": .32, + "oneWayFrameLossRatio": .01 +} +</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_evcmgr_webapi_list"><span class="parent">/evcmgr/webapi</span>/list</a> <span class="methods"><a href="#evcmgr_webapi_list_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_evcmgr_webapi_list" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Get a list of all EVC instances</p></div><div class="list-group"><div onclick="window.location.href = '#evcmgr_webapi_list_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Query a list of all existing EVC instances</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="evcmgr_webapi_list_get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/evcmgr/webapi</span>/list</h4></div><div class="modal-body"><div class="alert alert-info"><p>Query a list of all existing EVC instances</p></div><ul class="nav nav-tabs"></ul><div class="tab-content"></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="cosmgr_webapi" class="panel-title">CRUD MEF CoS Instances</h3></div><div class="panel-body"><div class="top-resource-description"><p>CRUD MEF CoS Instances</p></div><div class="panel-group"><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_cosmgr_webapi"><span class="parent"></span>/cosmgr/webapi</a> <span class="methods"><a href="#cosmgr_webapi_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_cosmgr_webapi" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#cosmgr_webapi_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>Create an new COS instance</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="cosmgr_webapi_post"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent"></span>/cosmgr/webapi</h4></div><div class="modal-body"><div class="alert alert-info"><p>Create an new COS instance</p></div><ul class="nav nav-tabs"><li class="active"><a href="#cosmgr_webapi_post_request" data-toggle="tab">Request</a></li><li><a href="#cosmgr_webapi_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="cosmgr_webapi_post_request"><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{ + "id": { + "required": true, + "type": "string" + }, + "commitedInfoRate": { + "required": true, + "type": "long" + }, + "availbility": { + "required": true, + "type": "double" + }, + "frameDelay": { + "required": true, + "type": "double" + }, + "frameLoss": { + "required": true, + "type": "double" + }, + "jitter": { + "required": true, + "type": "double" + } +} +</code></pre><p><strong>Example</strong>:</p><pre><code>{ + "id": "gold", + "commitedInfoRate": 100, + "availbility": 0.99, + "frameDelay": 17.43, + "frameLoss": 0.01, + "jitter": 2.43 +} +</code></pre></div><div class="tab-pane" id="cosmgr_webapi_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>JSON representing created COS instance</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{ + "id": { + "required": true, + "type": "string" + }, + "commitedInfoRate": { + "required": true, + "type": "long" + }, + "availbility": { + "required": true, + "type": "double" + }, + "frameDelay": { + "required": true, + "type": "double" + }, + "frameLoss": { + "required": true, + "type": "double" + }, + "jitter": { + "required": true, + "type": "double" + } +} +</code></pre><p><strong>Example</strong>:</p><pre><code>{ + "id": "gold", + "commitedInfoRate": 100, + "availbility": 0.99, + "frameDelay": 17.43, + "frameLoss": 0.01, + "jitter": 2.43 +} +</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_cosmgr_webapi__cosid_"><span class="parent">/cosmgr/webapi</span>/{cosid}</a> <span class="methods"><a href="#cosmgr_webapi__cosid__put"><span class="badge badge_put">put</span></a> <a href="#cosmgr_webapi__cosid__get"><span class="badge badge_get">get</span></a> <a href="#cosmgr_webapi__cosid__delete"><span class="badge badge_delete">delete</span></a></span></h4></div><div id="panel_cosmgr_webapi__cosid_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#cosmgr_webapi__cosid__put'" class="list-group-item"><span class="badge badge_put">put</span><div class="method_description"><p>Modify an existing COS instance</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#cosmgr_webapi__cosid__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Query an existing COS instance</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#cosmgr_webapi__cosid__delete'" class="list-group-item"><span class="badge badge_delete">delete</span><div class="method_description"><p>delete an existing EPL instance</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="cosmgr_webapi__cosid__put"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put</span> <span class="parent">/cosmgr/webapi</span>/{cosid}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Modify an existing COS instance</p></div><ul class="nav nav-tabs"><li class="active"><a href="#cosmgr_webapi__cosid__put_request" data-toggle="tab">Request</a></li><li><a href="#cosmgr_webapi__cosid__put_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="cosmgr_webapi__cosid__put_request"><h3>URI Parameters</h3><ul><li><strong>cosid</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{ + "id": { + "required": true, + "type": "string" + }, + "commitedInfoRate": { + "required": true, + "type": "long" + }, + "availbility": { + "required": true, + "type": "double" + }, + "frameDelay": { + "required": true, + "type": "double" + }, + "frameLoss": { + "required": true, + "type": "double" + }, + "jitter": { + "required": true, + "type": "double" + } +} +</code></pre><p><strong>Example</strong>:</p><pre><code>{ + "id": "gold", + "commitedInfoRate": 100, + "availbility": 0.99, + "frameDelay": 17.43, + "frameLoss": 0.01, + "jitter": 2.43 +} +</code></pre></div><div class="tab-pane" id="cosmgr_webapi__cosid__put_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>JSON representing modified COS instance</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{ + "id": { + "required": true, + "type": "string" + }, + "commitedInfoRate": { + "required": true, + "type": "long" + }, + "availbility": { + "required": true, + "type": "double" + }, + "frameDelay": { + "required": true, + "type": "double" + }, + "frameLoss": { + "required": true, + "type": "double" + }, + "jitter": { + "required": true, + "type": "double" + } +} +</code></pre><p><strong>Example</strong>:</p><pre><code>{ + "id": "gold", + "commitedInfoRate": 100, + "availbility": 0.99, + "frameDelay": 17.43, + "frameLoss": 0.01, + "jitter": 2.43 +} +</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="cosmgr_webapi__cosid__get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/cosmgr/webapi</span>/{cosid}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Query an existing COS instance</p></div><ul class="nav nav-tabs"><li class="active"><a href="#cosmgr_webapi__cosid__get_request" data-toggle="tab">Request</a></li><li><a href="#cosmgr_webapi__cosid__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="cosmgr_webapi__cosid__get_request"><h3>URI Parameters</h3><ul><li><strong>cosid</strong>: <em>required (string)</em></li></ul></div><div class="tab-pane" id="cosmgr_webapi__cosid__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>JSON representing the queried EPL instance</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{ + "id": { + "required": true, + "type": "string" + }, + "commitedInfoRate": { + "required": true, + "type": "long" + }, + "availbility": { + "required": true, + "type": "double" + }, + "frameDelay": { + "required": true, + "type": "double" + }, + "frameLoss": { + "required": true, + "type": "double" + }, + "jitter": { + "required": true, + "type": "double" + } +} +</code></pre><p><strong>Example</strong>:</p><pre><code>{ + "id": "gold", + "commitedInfoRate": 100, + "availbility": 0.99, + "frameDelay": 17.43, + "frameLoss": 0.01, + "jitter": 2.43 +} +</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="cosmgr_webapi__cosid__delete"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_delete">delete</span> <span class="parent">/cosmgr/webapi</span>/{cosid}</h4></div><div class="modal-body"><div class="alert alert-info"><p>delete an existing EPL instance</p></div><ul class="nav nav-tabs"><li class="active"><a href="#cosmgr_webapi__cosid__delete_request" data-toggle="tab">Request</a></li><li><a href="#cosmgr_webapi__cosid__delete_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="cosmgr_webapi__cosid__delete_request"><h3>URI Parameters</h3><ul><li><strong>cosid</strong>: <em>required (string)</em></li></ul></div><div class="tab-pane" id="cosmgr_webapi__cosid__delete_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>JSON representing deleted COS instance</p><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{ + "id": { + "required": true, + "type": "string" + }, + "commitedInfoRate": { + "required": true, + "type": "long" + }, + "availbility": { + "required": true, + "type": "double" + }, + "frameDelay": { + "required": true, + "type": "double" + }, + "frameLoss": { + "required": true, + "type": "double" + }, + "jitter": { + "required": true, + "type": "double" + } +} +</code></pre><p><strong>Example</strong>:</p><pre><code>{ + "id": "gold", + "commitedInfoRate": 100, + "availbility": 0.99, + "frameDelay": 17.43, + "frameLoss": 0.01, + "jitter": 2.43 +} +</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_cosmgr_webapi_list"><span class="parent">/cosmgr/webapi</span>/list</a> <span class="methods"><a href="#cosmgr_webapi_list_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_cosmgr_webapi_list" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Get a list of all COS instances</p></div><div class="list-group"><div onclick="window.location.href = '#cosmgr_webapi_list_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Query a list of all existing COS instances</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="cosmgr_webapi_list_get"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/cosmgr/webapi</span>/list</h4></div><div class="modal-body"><div class="alert alert-info"><p>Query a list of all existing COS instances</p></div><ul class="nav nav-tabs"></ul><div class="tab-content"></div></div></div></div></div></div></div></div></div></div><div class="col-md-3"><div id="sidebar" class="hidden-print affix" role="complementary"><ul class="nav nav-pills nav-stacked"><li><a href="#svcmgr_webapi">CRUD Instances of MEF Defined Services</a></li><li><a href="#evcmgr_webapi">CRUD MEF EVC Instances</a></li><li><a href="#cosmgr_webapi">CRUD MEF CoS Instances</a></li></ul></div></div></div></div></body></html>
\ No newline at end of file |