diff options
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/swagger/swagger.html | 5772 | ||||
| -rw-r--r-- | docs/api/swagger/swagger.json | 580 | ||||
| -rw-r--r-- | docs/api/swagger/swagger.yaml | 401 |
3 files changed, 6615 insertions, 138 deletions
diff --git a/docs/api/swagger/swagger.html b/docs/api/swagger/swagger.html index 3c577b7c07..514c2bdda2 100644 --- a/docs/api/swagger/swagger.html +++ b/docs/api/swagger/swagger.html @@ -2,7 +2,7 @@ <html> <head> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> - <title>SO Casablanca APIs</title> + <title>SO Guilin APIs</title> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta charset="UTF-8" /> @@ -696,6 +696,338 @@ margin-bottom: 20px; <script> // Script section to load models into a JS Var var defs = {} + defs["3gppServiceActivation"] = { + "type" : "object", + "properties" : { + "serviceInstanceID" : { + "type" : "string", + "description" : "ID of the service to be activated/deactivated" + }, + "globalSubscriberId" : { + "type" : "string" + }, + "subscriptionServiceType" : { + "type" : "string", + "description" : "Service type for the subscription. For E.G :5G" + }, + "networkType" : { + "type" : "string", + "description" : "Network type. For E.G :AN/CN/TN" + }, + "additionalProperties" : { + "type" : "object", + "description" : "Map of additional properties required for service activation/deactivation", + "properties" : { } + } + }, + "description" : "This describes the request body for 3gpp service activation/deactivation" +}; + defs["3gppServiceResponse"] = { + "type" : "object", + "properties" : { + "jobId" : { + "type" : "string", + "description" : "Job ID to be used to identify the status of the job" + }, + "status" : { + "type" : "string", + "description" : "status of the job" + }, + "statusDescription" : { + "type" : "object", + "description" : "Description on status in case of erroneous response", + "properties" : { } + } + }, + "description" : "This describes the response for 3gpp services" +}; + defs["Allocate3gppService"] = { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "Name of the service to allocate" + }, + "modelInvariantUuid" : { + "type" : "string", + "description" : "Model Invariant UUID corresponding to the service. For E.g : NSST Model invariant uuid in case of NSSI creation" + }, + "modelUuid" : { + "type" : "string", + "description" : "Model UUID corresponding to the service. For E.g : NSST Model uuid in case of NSSI creation" + }, + "globalSubscriberId" : { + "type" : "string" + }, + "subscriptionServiceType" : { + "type" : "string", + "description" : "Service type for the subscription. For E.G :5G" + }, + "networkType" : { + "type" : "string", + "description" : "Network type. For E.G :AN/CN/TN" + }, + "additionalProperties" : { + "type" : "object", + "description" : "Map of additional properties required for service allocation", + "properties" : { } + } + }, + "description" : "This describes the request body for 3gpp service allocation" +}; + defs["DeAllocate3gppService"] = { + "type" : "object", + "properties" : { + "serviceInstanceID" : { + "type" : "string", + "description" : "ID of the service to terminate" + }, + "globalSubscriberId" : { + "type" : "string" + }, + "subscriptionServiceType" : { + "type" : "string", + "description" : "Service type for the subscription. For E.G :5G" + }, + "networkType" : { + "type" : "string", + "description" : "Network type. For E.G :AN/CN/TN" + }, + "additionalProperties" : { + "type" : "object", + "description" : "Map of additional properties required for service deallocation", + "properties" : { } + } + }, + "description" : "This describes the request body for 3gpp service Termination/Deallocation" +}; + defs["Modify3gppService"] = { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "Name of the service to modify" + }, + "serviceInstanceID" : { + "type" : "string", + "description" : "ID of the service to modify" + }, + "globalSubscriberId" : { + "type" : "string" + }, + "subscriptionServiceType" : { + "type" : "string", + "description" : "Service type for the subscription. For E.G :5G" + }, + "networkType" : { + "type" : "string", + "description" : "Network type. For E.G :AN/CN/TN" + }, + "additionalProperties" : { + "type" : "object", + "description" : "Map of additional properties required for service modification", + "properties" : { } + } + }, + "description" : "This describes the request body for 3gpp service modification" +}; + defs["QuerySubnetCapability"] = { + "type" : "object", + "properties" : { + "subnetTypes" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/SubnetTypes" + } + } + }, + "description" : "This describes the subnet capabilities that can be queried" +}; + defs["RetrievingWorkflowResponse"] = { + "type" : "object", + "properties" : { + "workflowSpecificationList" : { + "type" : "array", + "description" : "List of Workflow specification data", + "items" : { + "$ref" : "#/definitions/WorkflowSpecification" + } + } + }, + "description" : "Response body of fetching workflows using resource target" +}; + defs["ServiceLevelWorkflowExecution"] = { + "type" : "object", + "properties" : { + "requestInfo" : { + "$ref" : "#/definitions/ServiceLevelWorkflowExecution_requestInfo" + }, + "modelInfo" : { + "$ref" : "#/definitions/ServiceLevelWorkflowExecution_modelInfo" + }, + "requestParameters" : { + "$ref" : "#/definitions/ServiceLevelWorkflowExecution_requestParameters" + }, + "subscriberInfo" : { + "$ref" : "#/definitions/ServiceLevelWorkflowExecution_subscriberInfo" + }, + "project" : { + "$ref" : "#/definitions/ServiceLevelWorkflowExecution_project" + }, + "owningEntity" : { + "$ref" : "#/definitions/ServiceLevelWorkflowExecution_owningEntity" + } + }, + "description" : "This describes the request body of service level custom workflow execution" +}; + defs["ServiceLevelWorkflowExecution_modelInfo"] = { + "type" : "object", + "properties" : { + "modelType" : { + "type" : "string", + "description" : "Type of the model to be executed" + }, + "modelInvariantUuid" : { + "type" : "string", + "description" : "Model invariant id corresponding to the service" + }, + "modelUuid" : { + "type" : "string", + "description" : "Model uuid corresponding to the service" + }, + "modelVersionId" : { + "type" : "string", + "description" : "Model version of the service instance" + }, + "modelName" : { + "type" : "string", + "description" : "Name of the service" + }, + "modelVersion" : { + "type" : "string", + "description" : "Version of the service instance" + } + }, + "description" : "Parameters related to the service model" +}; + defs["ServiceLevelWorkflowExecution_owningEntity"] = { + "type" : "object", + "properties" : { + "owningEntityId" : { + "type" : "string", + "description" : "Id of the owning Entity" + }, + "owningEntityName" : { + "type" : "string", + "description" : "Name of the owning Entity" + } + }, + "description" : "Object describes the entity details" +}; + defs["ServiceLevelWorkflowExecution_project"] = { + "type" : "object", + "properties" : { + "projectName" : { + "type" : "string", + "description" : "Name of the target project" + } + }, + "description" : "Information about the target project name" +}; + defs["ServiceLevelWorkflowExecution_requestInfo"] = { + "type" : "object", + "properties" : { + "source" : { + "type" : "string", + "description" : "Name of the sender" + }, + "suppressRollback" : { + "type" : "boolean", + "description" : "Enable/disable rollback suppression" + }, + "requestorId" : { + "type" : "string", + "description" : "Id of the sender" + } + }, + "description" : "Request object contains source information" +}; + defs["ServiceLevelWorkflowExecution_requestParameters"] = { + "type" : "object", + "properties" : { + "subscriptionServiceType" : { + "type" : "string", + "description" : "Type of service subscription" + } + }, + "description" : "User parameter object" +}; + defs["ServiceLevelWorkflowExecution_subscriberInfo"] = { + "type" : "object", + "properties" : { + "globalSubscriberId" : { + "type" : "string", + "description" : "Id of the subscriber sending the request" + } + }, + "description" : "Subscriber id information" +}; + defs["SubnetTypes"] = { + "type" : "string", + "description" : "This describes allowed subnet types", + "enum" : [ "AN", "AN_NF", "CN", "TN_FH", "TN_MH", "TN_BH" ] +}; + defs["WorkflowSpecification"] = { + "type" : "object", + "properties" : { + "artifactInfo" : { + "$ref" : "#/definitions/WorkflowSpecification_artifactInfo" + } + }, + "description" : "This describes workflow specification object" +}; + defs["WorkflowSpecification_artifactInfo"] = { + "type" : "object", + "properties" : { + "artifactType" : { + "type" : "string", + "description" : "Type of the artifact to be queried" + }, + "artifactUuid" : { + "type" : "string", + "description" : "UUID of the artifact" + }, + "artifactName" : { + "type" : "string", + "description" : "Name of the artifact" + }, + "artifactVersion" : { + "type" : "string", + "description" : "Artifact's Version" + }, + "artifactDescription" : { + "type" : "string", + "description" : "" + }, + "workflowName" : { + "type" : "string", + "description" : "Name of the workflow fetched for the resource type" + }, + "operationName" : { + "type" : "string", + "description" : "Mapped operation name of the corresponding workflow" + }, + "workflowSource" : { + "type" : "string", + "description" : "" + }, + "workflowResourceTarget" : { + "type" : "string", + "description" : "Type of Resource mapped against the workflow" + } + }, + "description" : "Attributes related to artifact information " +}; </script> <div class="container-fluid"> @@ -713,6 +1045,9 @@ margin-bottom: 20px; <li class="nav-fixed nav-header active" data-group="_"><a href="#api-_">API Summary</a></li> <li class="nav-header" data-group="E2eServiceInstances"><a href="#api-E2eServiceInstances">API Methods - E2eServiceInstances</a></li> + <li data-group="E2eServiceInstances" data-name="activateE2EServiceInstances" class=""> + <a href="#api-E2eServiceInstances-activateE2EServiceInstances">activateE2EServiceInstances</a> + </li> <li data-group="E2eServiceInstances" data-name="compareModelwithTargetVersion" class=""> <a href="#api-E2eServiceInstances-compareModelwithTargetVersion">compareModelwithTargetVersion</a> </li> @@ -739,6 +1074,25 @@ margin-bottom: 20px; <li data-group="Nodehealthcheck" data-name="nodeHealthcheck" class=""> <a href="#api-Nodehealthcheck-nodeHealthcheck">nodeHealthcheck</a> </li> + <li class="nav-header" data-group="Onap3gppServiceInstances"><a href="#api-Onap3gppServiceInstances">API Methods - Onap3gppServiceInstances</a></li> + <li data-group="Onap3gppServiceInstances" data-name="activate3gppService" class=""> + <a href="#api-Onap3gppServiceInstances-activate3gppService">activate3gppService</a> + </li> + <li data-group="Onap3gppServiceInstances" data-name="allocate3gppService" class=""> + <a href="#api-Onap3gppServiceInstances-allocate3gppService">allocate3gppService</a> + </li> + <li data-group="Onap3gppServiceInstances" data-name="deactivate3gppService" class=""> + <a href="#api-Onap3gppServiceInstances-deactivate3gppService">deactivate3gppService</a> + </li> + <li data-group="Onap3gppServiceInstances" data-name="deallocate3gppService" class=""> + <a href="#api-Onap3gppServiceInstances-deallocate3gppService">deallocate3gppService</a> + </li> + <li data-group="Onap3gppServiceInstances" data-name="modify3gppService" class=""> + <a href="#api-Onap3gppServiceInstances-modify3gppService">modify3gppService</a> + </li> + <li data-group="Onap3gppServiceInstances" data-name="querySubnetCapability" class=""> + <a href="#api-Onap3gppServiceInstances-querySubnetCapability">querySubnetCapability</a> + </li> <li class="nav-header" data-group="OnapsoinfracloudResources"><a href="#api-OnapsoinfracloudResources">API Methods - OnapsoinfracloudResources</a></li> <li data-group="OnapsoinfracloudResources" data-name="activateOperationEnvironment" class=""> <a href="#api-OnapsoinfracloudResources-activateOperationEnvironment">activateOperationEnvironment</a> @@ -756,6 +1110,10 @@ margin-bottom: 20px; <li data-group="OnapsoinfracloudResourcesRequests" data-name="unlockOrchestrationRequestForReqId" class=""> <a href="#api-OnapsoinfracloudResourcesRequests-unlockOrchestrationRequestForReqId">unlockOrchestrationRequestForReqId</a> </li> + <li class="nav-header" data-group="OnapsoinfrainstanceManagement"><a href="#api-OnapsoinfrainstanceManagement">API Methods - OnapsoinfrainstanceManagement</a></li> + <li data-group="OnapsoinfrainstanceManagement" data-name="executeServiceLevelCustomWorkflow" class=""> + <a href="#api-OnapsoinfrainstanceManagement-executeServiceLevelCustomWorkflow">executeServiceLevelCustomWorkflow</a> + </li> <li class="nav-header" data-group="OnapsoinframodelDistributions"><a href="#api-OnapsoinframodelDistributions">API Methods - OnapsoinframodelDistributions</a></li> <li data-group="OnapsoinframodelDistributions" data-name="updateModelDistributionStatus" class=""> <a href="#api-OnapsoinframodelDistributions-updateModelDistributionStatus">updateModelDistributionStatus</a> @@ -770,6 +1128,28 @@ margin-bottom: 20px; <li data-group="OnapsoinfraorchestrationRequests" data-name="unlockOrchestrationRequest" class=""> <a href="#api-OnapsoinfraorchestrationRequests-unlockOrchestrationRequest">unlockOrchestrationRequest</a> </li> + <li class="nav-header" data-group="OnapsoinfraorchestrationTasks"><a href="#api-OnapsoinfraorchestrationTasks">API Methods - OnapsoinfraorchestrationTasks</a></li> + <li data-group="OnapsoinfraorchestrationTasks" data-name="abortOrchestrationTask" class=""> + <a href="#api-OnapsoinfraorchestrationTasks-abortOrchestrationTask">abortOrchestrationTask</a> + </li> + <li data-group="OnapsoinfraorchestrationTasks" data-name="commitOrchestrationTask" class=""> + <a href="#api-OnapsoinfraorchestrationTasks-commitOrchestrationTask">commitOrchestrationTask</a> + </li> + <li data-group="OnapsoinfraorchestrationTasks" data-name="createOrchestrationTask" class=""> + <a href="#api-OnapsoinfraorchestrationTasks-createOrchestrationTask">createOrchestrationTask</a> + </li> + <li data-group="OnapsoinfraorchestrationTasks" data-name="deleteOrchestrationTask" class=""> + <a href="#api-OnapsoinfraorchestrationTasks-deleteOrchestrationTask">deleteOrchestrationTask</a> + </li> + <li data-group="OnapsoinfraorchestrationTasks" data-name="getAllOrchestrationTasks" class=""> + <a href="#api-OnapsoinfraorchestrationTasks-getAllOrchestrationTasks">getAllOrchestrationTasks</a> + </li> + <li data-group="OnapsoinfraorchestrationTasks" data-name="getOrchestrationTask" class=""> + <a href="#api-OnapsoinfraorchestrationTasks-getOrchestrationTask">getOrchestrationTask</a> + </li> + <li data-group="OnapsoinfraorchestrationTasks" data-name="updateOrchestrationTask" class=""> + <a href="#api-OnapsoinfraorchestrationTasks-updateOrchestrationTask">updateOrchestrationTask</a> + </li> <li class="nav-header" data-group="OnapsoinfraserviceInstantiation"><a href="#api-OnapsoinfraserviceInstantiation">API Methods - OnapsoinfraserviceInstantiation</a></li> <li data-group="OnapsoinfraserviceInstantiation" data-name="activatePort" class=""> <a href="#api-OnapsoinfraserviceInstantiation-activatePort">activatePort</a> @@ -871,13 +1251,17 @@ margin-bottom: 20px; <li data-group="Onapsoinfratasks" data-name="queryFilters" class=""> <a href="#api-Onapsoinfratasks-queryFilters">queryFilters</a> </li> + <li class="nav-header" data-group="OnapsoinfraworkflowSpecifications"><a href="#api-OnapsoinfraworkflowSpecifications">API Methods - OnapsoinfraworkflowSpecifications</a></li> + <li data-group="OnapsoinfraworkflowSpecifications" data-name="queryWorkflowSpecifications" class=""> + <a href="#api-OnapsoinfraworkflowSpecifications-queryWorkflowSpecifications">queryWorkflowSpecifications</a> + </li> </ul> </nav> </div> <div id="content"> <div id="project"> <div class="pull-left"> - <h1>SO Casablanca APIs</h1> + <h1>SO Guilin APIs</h1> </div> <div class="clearfix"></div> </div> @@ -892,11 +1276,368 @@ margin-bottom: 20px; <div id="sections"> <section id="api-E2eServiceInstances"> <h1>E2eServiceInstances</h1> + <div id="api-E2eServiceInstances-activateE2EServiceInstances"> + <article id="api-E2eServiceInstances-activateE2EServiceInstances-0" data-group="User" data-name="activateE2EServiceInstances" data-version="0"> + <div class="pull-left"> + <h1>activateE2EServiceInstances</h1> + <p>Activate/Deactivate 5G slice Service on a specified version and serviceId</p> + </div> + <div class="pull-right"></div> + <div class="clearfix"></div> + <p></p> + <p class="marked"></p> + <p></p> + <br /> + <pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/{operationType}</span></code></pre> + <p> + <h3>Usage and SDK Samples</h3> + </p> + <ul class="nav nav-tabs nav-tabs-examples"> + <li class="active"><a href="#examples-E2eServiceInstances-activateE2EServiceInstances-0-curl">Curl</a></li> + <li class=""><a href="#examples-E2eServiceInstances-activateE2EServiceInstances-0-java">Java</a></li> + <li class=""><a href="#examples-E2eServiceInstances-activateE2EServiceInstances-0-android">Android</a></li> + <!--<li class=""><a href="#examples-E2eServiceInstances-activateE2EServiceInstances-0-groovy">Groovy</a></li>--> + <li class=""><a href="#examples-E2eServiceInstances-activateE2EServiceInstances-0-objc">Obj-C</a></li> + <li class=""><a href="#examples-E2eServiceInstances-activateE2EServiceInstances-0-javascript">JavaScript</a></li> + <!--<li class=""><a href="#examples-E2eServiceInstances-activateE2EServiceInstances-0-angular">Angular</a></li>--> + <li class=""><a href="#examples-E2eServiceInstances-activateE2EServiceInstances-0-csharp">C#</a></li> + <li class=""><a href="#examples-E2eServiceInstances-activateE2EServiceInstances-0-php">PHP</a></li> + <li class=""><a href="#examples-E2eServiceInstances-activateE2EServiceInstances-0-perl">Perl</a></li> + <li class=""><a href="#examples-E2eServiceInstances-activateE2EServiceInstances-0-python">Python</a></li> + </ul> + + <div class="tab-content"> + <div class="tab-pane active" id="examples-E2eServiceInstances-activateE2EServiceInstances-0-curl"> + <pre class="prettyprint"><code class="language-bsh">curl -X POST "http://localhost/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/{operationType}"</code></pre> + </div> + <div class="tab-pane" id="examples-E2eServiceInstances-activateE2EServiceInstances-0-java"> + <pre class="prettyprint"><code class="language-java">import io.swagger.client.*; +import io.swagger.client.auth.*; +import io.swagger.client.model.*; +import io.swagger.client.api.E2eServiceInstancesApi; + +import java.io.File; +import java.util.*; + +public class E2eServiceInstancesApiExample { + + public static void main(String[] args) { + + E2eServiceInstancesApi apiInstance = new E2eServiceInstancesApi(); + String version = version_example; // String | + String serviceId = serviceId_example; // String | + String operationType = operationType_example; // String | + String body = body_example; // String | + try { + apiInstance.activateE2EServiceInstances(version, serviceId, operationType, body); + } catch (ApiException e) { + System.err.println("Exception when calling E2eServiceInstancesApi#activateE2EServiceInstances"); + e.printStackTrace(); + } + } +}</code></pre> + </div> + + <div class="tab-pane" id="examples-E2eServiceInstances-activateE2EServiceInstances-0-android"> + <pre class="prettyprint"><code class="language-java">import io.swagger.client.api.E2eServiceInstancesApi; + +public class E2eServiceInstancesApiExample { + + public static void main(String[] args) { + E2eServiceInstancesApi apiInstance = new E2eServiceInstancesApi(); + String version = version_example; // String | + String serviceId = serviceId_example; // String | + String operationType = operationType_example; // String | + String body = body_example; // String | + try { + apiInstance.activateE2EServiceInstances(version, serviceId, operationType, body); + } catch (ApiException e) { + System.err.println("Exception when calling E2eServiceInstancesApi#activateE2EServiceInstances"); + e.printStackTrace(); + } + } +}</code></pre> + </div> + <!-- + <div class="tab-pane" id="examples-E2eServiceInstances-activateE2EServiceInstances-0-groovy"> + <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre> + </div> --> + <div class="tab-pane" id="examples-E2eServiceInstances-activateE2EServiceInstances-0-objc"> + <pre class="prettyprint"><code class="language-cpp">String *version = version_example; // +String *serviceId = serviceId_example; // +String *operationType = operationType_example; // +String *body = body_example; // (optional) + +E2eServiceInstancesApi *apiInstance = [[E2eServiceInstancesApi alloc] init]; + +// Activate/Deactivate 5G slice Service on a specified version and serviceId +[apiInstance activateE2EServiceInstancesWith:version + serviceId:serviceId + operationType:operationType + body:body + completionHandler: ^(NSError* error) { + if (error) { + NSLog(@"Error: %@", error); + } + }]; +</code></pre> + </div> + + <div class="tab-pane" id="examples-E2eServiceInstances-activateE2EServiceInstances-0-javascript"> + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); + +var api = new SoGuilinApIs.E2eServiceInstancesApi() + +var version = version_example; // {String} + +var serviceId = serviceId_example; // {String} + +var operationType = operationType_example; // {String} + +var opts = { + 'body': body_example // {String} +}; + +var callback = function(error, data, response) { + if (error) { + console.error(error); + } else { + console.log('API called successfully.'); + } +}; +api.activateE2EServiceInstances(version, serviceId, operationType, opts, callback); +</code></pre> + </div> + + <!--<div class="tab-pane" id="examples-E2eServiceInstances-activateE2EServiceInstances-0-angular"> + <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre> + </div>--> + <div class="tab-pane" id="examples-E2eServiceInstances-activateE2EServiceInstances-0-csharp"> + <pre class="prettyprint"><code class="language-cs">using System; +using System.Diagnostics; +using IO.Swagger.Api; +using IO.Swagger.Client; +using IO.Swagger.Model; + +namespace Example +{ + public class activateE2EServiceInstancesExample + { + public void main() + { + + var apiInstance = new E2eServiceInstancesApi(); + var version = version_example; // String | + var serviceId = serviceId_example; // String | + var operationType = operationType_example; // String | + var body = body_example; // String | (optional) + + try + { + // Activate/Deactivate 5G slice Service on a specified version and serviceId + apiInstance.activateE2EServiceInstances(version, serviceId, operationType, body); + } + catch (Exception e) + { + Debug.Print("Exception when calling E2eServiceInstancesApi.activateE2EServiceInstances: " + e.Message ); + } + } + } +} +</code></pre> + </div> + + <div class="tab-pane" id="examples-E2eServiceInstances-activateE2EServiceInstances-0-php"> + <pre class="prettyprint"><code class="language-php"><?php +require_once(__DIR__ . '/vendor/autoload.php'); + +$api_instance = new Swagger\Client\Api\E2eServiceInstancesApi(); +$version = version_example; // String | +$serviceId = serviceId_example; // String | +$operationType = operationType_example; // String | +$body = body_example; // String | + +try { + $api_instance->activateE2EServiceInstances($version, $serviceId, $operationType, $body); +} catch (Exception $e) { + echo 'Exception when calling E2eServiceInstancesApi->activateE2EServiceInstances: ', $e->getMessage(), PHP_EOL; +} +?></code></pre> + </div> + + <div class="tab-pane" id="examples-E2eServiceInstances-activateE2EServiceInstances-0-perl"> + <pre class="prettyprint"><code class="language-perl">use Data::Dumper; +use WWW::SwaggerClient::Configuration; +use WWW::SwaggerClient::E2eServiceInstancesApi; + +my $api_instance = WWW::SwaggerClient::E2eServiceInstancesApi->new(); +my $version = version_example; # String | +my $serviceId = serviceId_example; # String | +my $operationType = operationType_example; # String | +my $body = WWW::SwaggerClient::Object::String->new(); # String | + +eval { + $api_instance->activateE2EServiceInstances(version => $version, serviceId => $serviceId, operationType => $operationType, body => $body); +}; +if ($@) { + warn "Exception when calling E2eServiceInstancesApi->activateE2EServiceInstances: $@\n"; +}</code></pre> + </div> + + <div class="tab-pane" id="examples-E2eServiceInstances-activateE2EServiceInstances-0-python"> + <pre class="prettyprint"><code class="language-python">from __future__ import print_statement +import time +import swagger_client +from swagger_client.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = swagger_client.E2eServiceInstancesApi() +version = version_example # String | +serviceId = serviceId_example # String | +operationType = operationType_example # String | +body = body_example # String | (optional) + +try: + # Activate/Deactivate 5G slice Service on a specified version and serviceId + api_instance.activate_e2_e_service_instances(version, serviceId, operationType, body=body) +except ApiException as e: + print("Exception when calling E2eServiceInstancesApi->activateE2EServiceInstances: %s\n" % e)</code></pre> + </div> + </div> + + <h2>Parameters</h2> + + <div class="methodsubtabletitle">Path parameters</div> + <table id="methodsubtable"> + <tr> + <th width="150px">Name</th> + <th>Description</th> + </tr> + <tr><td style="width:150px;">version*</td> +<td> + + + <div id="d2e199_activateE2EServiceInstances_version"> + <div class="json-schema-view"> + <div class="primitive"> + <span class="type"> + String + </span> + + </div> + <div class="inner required"> + Required + </div> + </div> + </div> +</td> +</tr> + + <tr><td style="width:150px;">serviceId*</td> +<td> + + + <div id="d2e199_activateE2EServiceInstances_serviceId"> + <div class="json-schema-view"> + <div class="primitive"> + <span class="type"> + String + </span> + + </div> + <div class="inner required"> + Required + </div> + </div> + </div> +</td> +</tr> + + <tr><td style="width:150px;">operationType*</td> +<td> + + + <div id="d2e199_activateE2EServiceInstances_operationType"> + <div class="json-schema-view"> + <div class="primitive"> + <span class="type"> + String + </span> + + </div> + <div class="inner required"> + Required + </div> + </div> + </div> +</td> +</tr> + + </table> + + + <div class="methodsubtabletitle">Body parameters</div> + <table id="methodsubtable"> + <tr> + <th width="150px">Name</th> + <th>Description</th> + </tr> + <tr><td style="width:150px;">body </td> +<td> + + +<script> +$(document).ready(function() { + var schemaWrapper = { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "type" : "string" + } +}; + var schema = schemaWrapper.schema; + if (schema.$ref != null) { + schema = defsParser.$refs.get(schema.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema,2,{isBodyParam: true}); + var result = $('#d2e199_activateE2EServiceInstances_body'); + result.empty(); + result.append(view.render()); +}); +</script> +<div id="d2e199_activateE2EServiceInstances_body"></div> +</td> +</tr> + + </table> + + + + <h2>Responses</h2> + <h3> Status: default - successful operation </h3> + + <ul class="nav nav-tabs nav-tabs-examples" > + </ul> + + <div class="tab-content" style='margin-bottom: 10px;'> + </div> + + </article> + </div> + <hr> <div id="api-E2eServiceInstances-compareModelwithTargetVersion"> <article id="api-E2eServiceInstances-compareModelwithTargetVersion-0" data-group="User" data-name="compareModelwithTargetVersion" data-version="0"> <div class="pull-left"> <h1>compareModelwithTargetVersion</h1> - <p>Find added and deleted resources of target model for the e2eserviceInstance on a given serviceId </p> + <p>Find added and deleted resources of target model for the e2eserviceInstance on a given serviceId</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> @@ -983,7 +1724,7 @@ String *body = body_example; // (optional) E2eServiceInstancesApi *apiInstance = [[E2eServiceInstancesApi alloc] init]; -// Find added and deleted resources of target model for the e2eserviceInstance on a given serviceId +// Find added and deleted resources of target model for the e2eserviceInstance on a given serviceId [apiInstance compareModelwithTargetVersionWith:serviceId version:version body:body @@ -996,9 +1737,9 @@ E2eServiceInstancesApi *apiInstance = [[E2eServiceInstancesApi alloc] init]; </div> <div class="tab-pane" id="examples-E2eServiceInstances-compareModelwithTargetVersion-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.E2eServiceInstancesApi() +var api = new SoGuilinApIs.E2eServiceInstancesApi() var serviceId = serviceId_example; // {String} @@ -1043,7 +1784,7 @@ namespace Example try { - // Find added and deleted resources of target model for the e2eserviceInstance on a given serviceId + // Find added and deleted resources of target model for the e2eserviceInstance on a given serviceId apiInstance.compareModelwithTargetVersion(serviceId, version, body); } catch (Exception e) @@ -1105,7 +1846,7 @@ version = version_example # String | body = body_example # String | (optional) try: - # Find added and deleted resources of target model for the e2eserviceInstance on a given serviceId + # Find added and deleted resources of target model for the e2eserviceInstance on a given serviceId api_instance.compare_modelwith_target_version(serviceId, version, body=body) except ApiException as e: print("Exception when calling E2eServiceInstancesApi->compareModelwithTargetVersion: %s\n" % e)</code></pre> @@ -1319,9 +2060,9 @@ E2eServiceInstancesApi *apiInstance = [[E2eServiceInstancesApi alloc] init]; </div> <div class="tab-pane" id="examples-E2eServiceInstances-createE2EServiceInstance-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.E2eServiceInstancesApi() +var api = new SoGuilinApIs.E2eServiceInstancesApi() var version = version_example; // {String} @@ -1620,9 +2361,9 @@ E2eServiceInstancesApi *apiInstance = [[E2eServiceInstancesApi alloc] init]; </div> <div class="tab-pane" id="examples-E2eServiceInstances-deleteE2EServiceInstance-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.E2eServiceInstancesApi() +var api = new SoGuilinApIs.E2eServiceInstancesApi() var version = version_example; // {String} @@ -1947,9 +2688,9 @@ E2eServiceInstancesApi *apiInstance = [[E2eServiceInstancesApi alloc] init]; </div> <div class="tab-pane" id="examples-E2eServiceInstances-getE2EServiceInstances-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.E2eServiceInstancesApi() +var api = new SoGuilinApIs.E2eServiceInstancesApi() var serviceId = serviceId_example; // {String} @@ -2252,9 +2993,9 @@ E2eServiceInstancesApi *apiInstance = [[E2eServiceInstancesApi alloc] init]; </div> <div class="tab-pane" id="examples-E2eServiceInstances-scaleE2EServiceInstance-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.E2eServiceInstancesApi() +var api = new SoGuilinApIs.E2eServiceInstancesApi() var version = version_example; // {String} @@ -2579,9 +3320,9 @@ E2eServiceInstancesApi *apiInstance = [[E2eServiceInstancesApi alloc] init]; </div> <div class="tab-pane" id="examples-E2eServiceInstances-updateE2EServiceInstance-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.E2eServiceInstancesApi() +var api = new SoGuilinApIs.E2eServiceInstancesApi() var version = version_example; // {String} @@ -2901,9 +3642,9 @@ GlobalhealthcheckApi *apiInstance = [[GlobalhealthcheckApi alloc] init]; </div> <div class="tab-pane" id="examples-Globalhealthcheck-globalHealthcheck-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.GlobalhealthcheckApi() +var api = new SoGuilinApIs.GlobalhealthcheckApi() var opts = { 'enableBpmn': true // {Boolean} @@ -3144,9 +3885,9 @@ NodehealthcheckApi *apiInstance = [[NodehealthcheckApi alloc] init]; </div> <div class="tab-pane" id="examples-Nodehealthcheck-nodeHealthcheck-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.NodehealthcheckApi() +var api = new SoGuilinApIs.NodehealthcheckApi() var callback = function(error, data, response) { if (error) { @@ -3260,6 +4001,2049 @@ except ApiException as e: </div> <hr> </section> + <section id="api-Onap3gppServiceInstances"> + <h1>Onap3gppServiceInstances</h1> + <div id="api-Onap3gppServiceInstances-activate3gppService"> + <article id="api-Onap3gppServiceInstances-activate3gppService-0" data-group="User" data-name="activate3gppService" data-version="0"> + <div class="pull-left"> + <h1>activate3gppService</h1> + <p>Activate a 3GPP Service Instance on a version provided</p> + </div> + <div class="pull-right"></div> + <div class="clearfix"></div> + <p></p> + <p class="marked"></p> + <p></p> + <br /> + <pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/onap/so/infra/3gppservices/{version}/activate</span></code></pre> + <p> + <h3>Usage and SDK Samples</h3> + </p> + <ul class="nav nav-tabs nav-tabs-examples"> + <li class="active"><a href="#examples-Onap3gppServiceInstances-activate3gppService-0-curl">Curl</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-activate3gppService-0-java">Java</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-activate3gppService-0-android">Android</a></li> + <!--<li class=""><a href="#examples-Onap3gppServiceInstances-activate3gppService-0-groovy">Groovy</a></li>--> + <li class=""><a href="#examples-Onap3gppServiceInstances-activate3gppService-0-objc">Obj-C</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-activate3gppService-0-javascript">JavaScript</a></li> + <!--<li class=""><a href="#examples-Onap3gppServiceInstances-activate3gppService-0-angular">Angular</a></li>--> + <li class=""><a href="#examples-Onap3gppServiceInstances-activate3gppService-0-csharp">C#</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-activate3gppService-0-php">PHP</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-activate3gppService-0-perl">Perl</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-activate3gppService-0-python">Python</a></li> + </ul> + + <div class="tab-content"> + <div class="tab-pane active" id="examples-Onap3gppServiceInstances-activate3gppService-0-curl"> + <pre class="prettyprint"><code class="language-bsh">curl -X POST "http://localhost/onap/so/infra/3gppservices/{version}/activate"</code></pre> + </div> + <div class="tab-pane" id="examples-Onap3gppServiceInstances-activate3gppService-0-java"> + <pre class="prettyprint"><code class="language-java">import io.swagger.client.*; +import io.swagger.client.auth.*; +import io.swagger.client.model.*; +import io.swagger.client.api.Onap3gppServiceInstancesApi; + +import java.io.File; +import java.util.*; + +public class Onap3gppServiceInstancesApiExample { + + public static void main(String[] args) { + + Onap3gppServiceInstancesApi apiInstance = new Onap3gppServiceInstancesApi(); + 3gppServiceActivation body = ; // 3gppServiceActivation | + String version = version_example; // String | + try { + 3gppServiceResponse result = apiInstance.activate3gppService(body, version); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling Onap3gppServiceInstancesApi#activate3gppService"); + e.printStackTrace(); + } + } +}</code></pre> + </div> + + <div class="tab-pane" id="examples-Onap3gppServiceInstances-activate3gppService-0-android"> + <pre class="prettyprint"><code class="language-java">import io.swagger.client.api.Onap3gppServiceInstancesApi; + +public class Onap3gppServiceInstancesApiExample { + + public static void main(String[] args) { + Onap3gppServiceInstancesApi apiInstance = new Onap3gppServiceInstancesApi(); + 3gppServiceActivation body = ; // 3gppServiceActivation | + String version = version_example; // String | + try { + 3gppServiceResponse result = apiInstance.activate3gppService(body, version); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling Onap3gppServiceInstancesApi#activate3gppService"); + e.printStackTrace(); + } + } +}</code></pre> + </div> + <!-- + <div class="tab-pane" id="examples-Onap3gppServiceInstances-activate3gppService-0-groovy"> + <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre> + </div> --> + <div class="tab-pane" id="examples-Onap3gppServiceInstances-activate3gppService-0-objc"> + <pre class="prettyprint"><code class="language-cpp">3gppServiceActivation *body = ; // +String *version = version_example; // + +Onap3gppServiceInstancesApi *apiInstance = [[Onap3gppServiceInstancesApi alloc] init]; + +// Activate a 3GPP Service Instance on a version provided +[apiInstance activate3gppServiceWith:body + version:version + completionHandler: ^(3gppServiceResponse output, NSError* error) { + if (output) { + NSLog(@"%@", output); + } + if (error) { + NSLog(@"Error: %@", error); + } + }]; +</code></pre> + </div> + + <div class="tab-pane" id="examples-Onap3gppServiceInstances-activate3gppService-0-javascript"> + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); + +var api = new SoGuilinApIs.Onap3gppServiceInstancesApi() + +var body = ; // {3gppServiceActivation} + +var version = version_example; // {String} + + +var callback = function(error, data, response) { + if (error) { + console.error(error); + } else { + console.log('API called successfully. Returned data: ' + data); + } +}; +api.activate3gppService(body, version, callback); +</code></pre> + </div> + + <!--<div class="tab-pane" id="examples-Onap3gppServiceInstances-activate3gppService-0-angular"> + <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre> + </div>--> + <div class="tab-pane" id="examples-Onap3gppServiceInstances-activate3gppService-0-csharp"> + <pre class="prettyprint"><code class="language-cs">using System; +using System.Diagnostics; +using IO.Swagger.Api; +using IO.Swagger.Client; +using IO.Swagger.Model; + +namespace Example +{ + public class activate3gppServiceExample + { + public void main() + { + + var apiInstance = new Onap3gppServiceInstancesApi(); + var body = new 3gppServiceActivation(); // 3gppServiceActivation | + var version = version_example; // String | + + try + { + // Activate a 3GPP Service Instance on a version provided + 3gppServiceResponse result = apiInstance.activate3gppService(body, version); + Debug.WriteLine(result); + } + catch (Exception e) + { + Debug.Print("Exception when calling Onap3gppServiceInstancesApi.activate3gppService: " + e.Message ); + } + } + } +} +</code></pre> + </div> + + <div class="tab-pane" id="examples-Onap3gppServiceInstances-activate3gppService-0-php"> + <pre class="prettyprint"><code class="language-php"><?php +require_once(__DIR__ . '/vendor/autoload.php'); + +$api_instance = new Swagger\Client\Api\Onap3gppServiceInstancesApi(); +$body = ; // 3gppServiceActivation | +$version = version_example; // String | + +try { + $result = $api_instance->activate3gppService($body, $version); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling Onap3gppServiceInstancesApi->activate3gppService: ', $e->getMessage(), PHP_EOL; +} +?></code></pre> + </div> + + <div class="tab-pane" id="examples-Onap3gppServiceInstances-activate3gppService-0-perl"> + <pre class="prettyprint"><code class="language-perl">use Data::Dumper; +use WWW::SwaggerClient::Configuration; +use WWW::SwaggerClient::Onap3gppServiceInstancesApi; + +my $api_instance = WWW::SwaggerClient::Onap3gppServiceInstancesApi->new(); +my $body = WWW::SwaggerClient::Object::3gppServiceActivation->new(); # 3gppServiceActivation | +my $version = version_example; # String | + +eval { + my $result = $api_instance->activate3gppService(body => $body, version => $version); + print Dumper($result); +}; +if ($@) { + warn "Exception when calling Onap3gppServiceInstancesApi->activate3gppService: $@\n"; +}</code></pre> + </div> + + <div class="tab-pane" id="examples-Onap3gppServiceInstances-activate3gppService-0-python"> + <pre class="prettyprint"><code class="language-python">from __future__ import print_statement +import time +import swagger_client +from swagger_client.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = swagger_client.Onap3gppServiceInstancesApi() +body = # 3gppServiceActivation | +version = version_example # String | + +try: + # Activate a 3GPP Service Instance on a version provided + api_response = api_instance.activate3gpp_service(body, version) + pprint(api_response) +except ApiException as e: + print("Exception when calling Onap3gppServiceInstancesApi->activate3gppService: %s\n" % e)</code></pre> + </div> + </div> + + <h2>Parameters</h2> + + <div class="methodsubtabletitle">Path parameters</div> + <table id="methodsubtable"> + <tr> + <th width="150px">Name</th> + <th>Description</th> + </tr> + <tr><td style="width:150px;">version*</td> +<td> + + + <div id="d2e199_activate3gppService_version"> + <div class="json-schema-view"> + <div class="primitive"> + <span class="type"> + String + </span> + + </div> + <div class="inner required"> + Required + </div> + </div> + </div> +</td> +</tr> + + </table> + + + <div class="methodsubtabletitle">Body parameters</div> + <table id="methodsubtable"> + <tr> + <th width="150px">Name</th> + <th>Description</th> + </tr> + <tr><td style="width:150px;">body <span style="color:red;">*</span></td> +<td> + + +<script> +$(document).ready(function() { + var schemaWrapper = { + "in" : "body", + "name" : "body", + "required" : true, + "schema" : { + "$ref" : "#/definitions/3gppServiceActivation" + } +}; + var schema = schemaWrapper.schema; + if (schema.$ref != null) { + schema = defsParser.$refs.get(schema.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema,2,{isBodyParam: true}); + var result = $('#d2e199_activate3gppService_body'); + result.empty(); + result.append(view.render()); +}); +</script> +<div id="d2e199_activate3gppService_body"></div> +</td> +</tr> + + </table> + + + + <h2>Responses</h2> + <h3> Status: default - successful operation </h3> + + <ul class="nav nav-tabs nav-tabs-examples" > + <li class="active"> + <a data-toggle="tab" href="#responses-activate3gppService-default-schema">Schema</a> + </li> + + </ul> + + <div class="tab-content" style='margin-bottom: 10px;'> + <div class="tab-pane active" id="responses-activate3gppService-default-schema"> + <div id='responses-activate3gppService-default-schema-default' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;"> + <script> + $(document).ready(function() { + var schemaWrapper = { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/3gppServiceResponse" + } +}; + var schema = schemaWrapper.schema; + if (schema.$ref != null) { + schema = defsParser.$refs.get(schema.$ref); + } else { + schemaWrapper.definitions = defs; + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + //console.log(JSON.stringify(schema)); + var view = new JSONSchemaView(schema, 3); + $('#responses-activate3gppService-default-schema-data').val(stringify(schema)); + var result = $('#responses-activate3gppService-default-schema-default'); + result.empty(); + result.append(view.render()); + }); + </script> + </div> + <input id='responses-activate3gppService-default-schema-data' type='hidden' value=''></input> + </div> + </div> + + </article> + </div> + <hr> + <div id="api-Onap3gppServiceInstances-allocate3gppService"> + <article id="api-Onap3gppServiceInstances-allocate3gppService-0" data-group="User" data-name="allocate3gppService" data-version="0"> + <div class="pull-left"> + <h1>allocate3gppService</h1> + <p>Create a 3GPP Service Instance on a version provided</p> + </div> + <div class="pull-right"></div> + <div class="clearfix"></div> + <p></p> + <p class="marked"></p> + <p></p> + <br /> + <pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/onap/so/infra/3gppservices/{version}/allocate</span></code></pre> + <p> + <h3>Usage and SDK Samples</h3> + </p> + <ul class="nav nav-tabs nav-tabs-examples"> + <li class="active"><a href="#examples-Onap3gppServiceInstances-allocate3gppService-0-curl">Curl</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-allocate3gppService-0-java">Java</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-allocate3gppService-0-android">Android</a></li> + <!--<li class=""><a href="#examples-Onap3gppServiceInstances-allocate3gppService-0-groovy">Groovy</a></li>--> + <li class=""><a href="#examples-Onap3gppServiceInstances-allocate3gppService-0-objc">Obj-C</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-allocate3gppService-0-javascript">JavaScript</a></li> + <!--<li class=""><a href="#examples-Onap3gppServiceInstances-allocate3gppService-0-angular">Angular</a></li>--> + <li class=""><a href="#examples-Onap3gppServiceInstances-allocate3gppService-0-csharp">C#</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-allocate3gppService-0-php">PHP</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-allocate3gppService-0-perl">Perl</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-allocate3gppService-0-python">Python</a></li> + </ul> + + <div class="tab-content"> + <div class="tab-pane active" id="examples-Onap3gppServiceInstances-allocate3gppService-0-curl"> + <pre class="prettyprint"><code class="language-bsh">curl -X POST "http://localhost/onap/so/infra/3gppservices/{version}/allocate"</code></pre> + </div> + <div class="tab-pane" id="examples-Onap3gppServiceInstances-allocate3gppService-0-java"> + <pre class="prettyprint"><code class="language-java">import io.swagger.client.*; +import io.swagger.client.auth.*; +import io.swagger.client.model.*; +import io.swagger.client.api.Onap3gppServiceInstancesApi; + +import java.io.File; +import java.util.*; + +public class Onap3gppServiceInstancesApiExample { + + public static void main(String[] args) { + + Onap3gppServiceInstancesApi apiInstance = new Onap3gppServiceInstancesApi(); + Allocate3gppService body = ; // Allocate3gppService | + String version = version_example; // String | + try { + 3gppServiceResponse result = apiInstance.allocate3gppService(body, version); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling Onap3gppServiceInstancesApi#allocate3gppService"); + e.printStackTrace(); + } + } +}</code></pre> + </div> + + <div class="tab-pane" id="examples-Onap3gppServiceInstances-allocate3gppService-0-android"> + <pre class="prettyprint"><code class="language-java">import io.swagger.client.api.Onap3gppServiceInstancesApi; + +public class Onap3gppServiceInstancesApiExample { + + public static void main(String[] args) { + Onap3gppServiceInstancesApi apiInstance = new Onap3gppServiceInstancesApi(); + Allocate3gppService body = ; // Allocate3gppService | + String version = version_example; // String | + try { + 3gppServiceResponse result = apiInstance.allocate3gppService(body, version); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling Onap3gppServiceInstancesApi#allocate3gppService"); + e.printStackTrace(); + } + } +}</code></pre> + </div> + <!-- + <div class="tab-pane" id="examples-Onap3gppServiceInstances-allocate3gppService-0-groovy"> + <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre> + </div> --> + <div class="tab-pane" id="examples-Onap3gppServiceInstances-allocate3gppService-0-objc"> + <pre class="prettyprint"><code class="language-cpp">Allocate3gppService *body = ; // +String *version = version_example; // + +Onap3gppServiceInstancesApi *apiInstance = [[Onap3gppServiceInstancesApi alloc] init]; + +// Create a 3GPP Service Instance on a version provided +[apiInstance allocate3gppServiceWith:body + version:version + completionHandler: ^(3gppServiceResponse output, NSError* error) { + if (output) { + NSLog(@"%@", output); + } + if (error) { + NSLog(@"Error: %@", error); + } + }]; +</code></pre> + </div> + + <div class="tab-pane" id="examples-Onap3gppServiceInstances-allocate3gppService-0-javascript"> + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); + +var api = new SoGuilinApIs.Onap3gppServiceInstancesApi() + +var body = ; // {Allocate3gppService} + +var version = version_example; // {String} + + +var callback = function(error, data, response) { + if (error) { + console.error(error); + } else { + console.log('API called successfully. Returned data: ' + data); + } +}; +api.allocate3gppService(body, version, callback); +</code></pre> + </div> + + <!--<div class="tab-pane" id="examples-Onap3gppServiceInstances-allocate3gppService-0-angular"> + <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre> + </div>--> + <div class="tab-pane" id="examples-Onap3gppServiceInstances-allocate3gppService-0-csharp"> + <pre class="prettyprint"><code class="language-cs">using System; +using System.Diagnostics; +using IO.Swagger.Api; +using IO.Swagger.Client; +using IO.Swagger.Model; + +namespace Example +{ + public class allocate3gppServiceExample + { + public void main() + { + + var apiInstance = new Onap3gppServiceInstancesApi(); + var body = new Allocate3gppService(); // Allocate3gppService | + var version = version_example; // String | + + try + { + // Create a 3GPP Service Instance on a version provided + 3gppServiceResponse result = apiInstance.allocate3gppService(body, version); + Debug.WriteLine(result); + } + catch (Exception e) + { + Debug.Print("Exception when calling Onap3gppServiceInstancesApi.allocate3gppService: " + e.Message ); + } + } + } +} +</code></pre> + </div> + + <div class="tab-pane" id="examples-Onap3gppServiceInstances-allocate3gppService-0-php"> + <pre class="prettyprint"><code class="language-php"><?php +require_once(__DIR__ . '/vendor/autoload.php'); + +$api_instance = new Swagger\Client\Api\Onap3gppServiceInstancesApi(); +$body = ; // Allocate3gppService | +$version = version_example; // String | + +try { + $result = $api_instance->allocate3gppService($body, $version); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling Onap3gppServiceInstancesApi->allocate3gppService: ', $e->getMessage(), PHP_EOL; +} +?></code></pre> + </div> + + <div class="tab-pane" id="examples-Onap3gppServiceInstances-allocate3gppService-0-perl"> + <pre class="prettyprint"><code class="language-perl">use Data::Dumper; +use WWW::SwaggerClient::Configuration; +use WWW::SwaggerClient::Onap3gppServiceInstancesApi; + +my $api_instance = WWW::SwaggerClient::Onap3gppServiceInstancesApi->new(); +my $body = WWW::SwaggerClient::Object::Allocate3gppService->new(); # Allocate3gppService | +my $version = version_example; # String | + +eval { + my $result = $api_instance->allocate3gppService(body => $body, version => $version); + print Dumper($result); +}; +if ($@) { + warn "Exception when calling Onap3gppServiceInstancesApi->allocate3gppService: $@\n"; +}</code></pre> + </div> + + <div class="tab-pane" id="examples-Onap3gppServiceInstances-allocate3gppService-0-python"> + <pre class="prettyprint"><code class="language-python">from __future__ import print_statement +import time +import swagger_client +from swagger_client.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = swagger_client.Onap3gppServiceInstancesApi() +body = # Allocate3gppService | +version = version_example # String | + +try: + # Create a 3GPP Service Instance on a version provided + api_response = api_instance.allocate3gpp_service(body, version) + pprint(api_response) +except ApiException as e: + print("Exception when calling Onap3gppServiceInstancesApi->allocate3gppService: %s\n" % e)</code></pre> + </div> + </div> + + <h2>Parameters</h2> + + <div class="methodsubtabletitle">Path parameters</div> + <table id="methodsubtable"> + <tr> + <th width="150px">Name</th> + <th>Description</th> + </tr> + <tr><td style="width:150px;">version*</td> +<td> + + + <div id="d2e199_allocate3gppService_version"> + <div class="json-schema-view"> + <div class="primitive"> + <span class="type"> + String + </span> + + </div> + <div class="inner required"> + Required + </div> + </div> + </div> +</td> +</tr> + + </table> + + + <div class="methodsubtabletitle">Body parameters</div> + <table id="methodsubtable"> + <tr> + <th width="150px">Name</th> + <th>Description</th> + </tr> + <tr><td style="width:150px;">body <span style="color:red;">*</span></td> +<td> + + +<script> +$(document).ready(function() { + var schemaWrapper = { + "in" : "body", + "name" : "body", + "required" : true, + "schema" : { + "$ref" : "#/definitions/Allocate3gppService" + } +}; + var schema = schemaWrapper.schema; + if (schema.$ref != null) { + schema = defsParser.$refs.get(schema.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema,2,{isBodyParam: true}); + var result = $('#d2e199_allocate3gppService_body'); + result.empty(); + result.append(view.render()); +}); +</script> +<div id="d2e199_allocate3gppService_body"></div> +</td> +</tr> + + </table> + + + + <h2>Responses</h2> + <h3> Status: default - successful operation </h3> + + <ul class="nav nav-tabs nav-tabs-examples" > + <li class="active"> + <a data-toggle="tab" href="#responses-allocate3gppService-default-schema">Schema</a> + </li> + + </ul> + + <div class="tab-content" style='margin-bottom: 10px;'> + <div class="tab-pane active" id="responses-allocate3gppService-default-schema"> + <div id='responses-allocate3gppService-default-schema-default' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;"> + <script> + $(document).ready(function() { + var schemaWrapper = { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/3gppServiceResponse" + } +}; + var schema = schemaWrapper.schema; + if (schema.$ref != null) { + schema = defsParser.$refs.get(schema.$ref); + } else { + schemaWrapper.definitions = defs; + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + //console.log(JSON.stringify(schema)); + var view = new JSONSchemaView(schema, 3); + $('#responses-allocate3gppService-default-schema-data').val(stringify(schema)); + var result = $('#responses-allocate3gppService-default-schema-default'); + result.empty(); + result.append(view.render()); + }); + </script> + </div> + <input id='responses-allocate3gppService-default-schema-data' type='hidden' value=''></input> + </div> + </div> + + </article> + </div> + <hr> + <div id="api-Onap3gppServiceInstances-deactivate3gppService"> + <article id="api-Onap3gppServiceInstances-deactivate3gppService-0" data-group="User" data-name="deactivate3gppService" data-version="0"> + <div class="pull-left"> + <h1>deactivate3gppService</h1> + <p>Deactivate a 3GPP Service Instance on a version provided</p> + </div> + <div class="pull-right"></div> + <div class="clearfix"></div> + <p></p> + <p class="marked"></p> + <p></p> + <br /> + <pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/onap/so/infra/3gppservices/{version}/deActivate</span></code></pre> + <p> + <h3>Usage and SDK Samples</h3> + </p> + <ul class="nav nav-tabs nav-tabs-examples"> + <li class="active"><a href="#examples-Onap3gppServiceInstances-deactivate3gppService-0-curl">Curl</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-deactivate3gppService-0-java">Java</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-deactivate3gppService-0-android">Android</a></li> + <!--<li class=""><a href="#examples-Onap3gppServiceInstances-deactivate3gppService-0-groovy">Groovy</a></li>--> + <li class=""><a href="#examples-Onap3gppServiceInstances-deactivate3gppService-0-objc">Obj-C</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-deactivate3gppService-0-javascript">JavaScript</a></li> + <!--<li class=""><a href="#examples-Onap3gppServiceInstances-deactivate3gppService-0-angular">Angular</a></li>--> + <li class=""><a href="#examples-Onap3gppServiceInstances-deactivate3gppService-0-csharp">C#</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-deactivate3gppService-0-php">PHP</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-deactivate3gppService-0-perl">Perl</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-deactivate3gppService-0-python">Python</a></li> + </ul> + + <div class="tab-content"> + <div class="tab-pane active" id="examples-Onap3gppServiceInstances-deactivate3gppService-0-curl"> + <pre class="prettyprint"><code class="language-bsh">curl -X POST "http://localhost/onap/so/infra/3gppservices/{version}/deActivate"</code></pre> + </div> + <div class="tab-pane" id="examples-Onap3gppServiceInstances-deactivate3gppService-0-java"> + <pre class="prettyprint"><code class="language-java">import io.swagger.client.*; +import io.swagger.client.auth.*; +import io.swagger.client.model.*; +import io.swagger.client.api.Onap3gppServiceInstancesApi; + +import java.io.File; +import java.util.*; + +public class Onap3gppServiceInstancesApiExample { + + public static void main(String[] args) { + + Onap3gppServiceInstancesApi apiInstance = new Onap3gppServiceInstancesApi(); + 3gppServiceActivation body = ; // 3gppServiceActivation | + String version = version_example; // String | + try { + 3gppServiceResponse result = apiInstance.deactivate3gppService(body, version); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling Onap3gppServiceInstancesApi#deactivate3gppService"); + e.printStackTrace(); + } + } +}</code></pre> + </div> + + <div class="tab-pane" id="examples-Onap3gppServiceInstances-deactivate3gppService-0-android"> + <pre class="prettyprint"><code class="language-java">import io.swagger.client.api.Onap3gppServiceInstancesApi; + +public class Onap3gppServiceInstancesApiExample { + + public static void main(String[] args) { + Onap3gppServiceInstancesApi apiInstance = new Onap3gppServiceInstancesApi(); + 3gppServiceActivation body = ; // 3gppServiceActivation | + String version = version_example; // String | + try { + 3gppServiceResponse result = apiInstance.deactivate3gppService(body, version); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling Onap3gppServiceInstancesApi#deactivate3gppService"); + e.printStackTrace(); + } + } +}</code></pre> + </div> + <!-- + <div class="tab-pane" id="examples-Onap3gppServiceInstances-deactivate3gppService-0-groovy"> + <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre> + </div> --> + <div class="tab-pane" id="examples-Onap3gppServiceInstances-deactivate3gppService-0-objc"> + <pre class="prettyprint"><code class="language-cpp">3gppServiceActivation *body = ; // +String *version = version_example; // + +Onap3gppServiceInstancesApi *apiInstance = [[Onap3gppServiceInstancesApi alloc] init]; + +// Deactivate a 3GPP Service Instance on a version provided +[apiInstance deactivate3gppServiceWith:body + version:version + completionHandler: ^(3gppServiceResponse output, NSError* error) { + if (output) { + NSLog(@"%@", output); + } + if (error) { + NSLog(@"Error: %@", error); + } + }]; +</code></pre> + </div> + + <div class="tab-pane" id="examples-Onap3gppServiceInstances-deactivate3gppService-0-javascript"> + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); + +var api = new SoGuilinApIs.Onap3gppServiceInstancesApi() + +var body = ; // {3gppServiceActivation} + +var version = version_example; // {String} + + +var callback = function(error, data, response) { + if (error) { + console.error(error); + } else { + console.log('API called successfully. Returned data: ' + data); + } +}; +api.deactivate3gppService(body, version, callback); +</code></pre> + </div> + + <!--<div class="tab-pane" id="examples-Onap3gppServiceInstances-deactivate3gppService-0-angular"> + <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre> + </div>--> + <div class="tab-pane" id="examples-Onap3gppServiceInstances-deactivate3gppService-0-csharp"> + <pre class="prettyprint"><code class="language-cs">using System; +using System.Diagnostics; +using IO.Swagger.Api; +using IO.Swagger.Client; +using IO.Swagger.Model; + +namespace Example +{ + public class deactivate3gppServiceExample + { + public void main() + { + + var apiInstance = new Onap3gppServiceInstancesApi(); + var body = new 3gppServiceActivation(); // 3gppServiceActivation | + var version = version_example; // String | + + try + { + // Deactivate a 3GPP Service Instance on a version provided + 3gppServiceResponse result = apiInstance.deactivate3gppService(body, version); + Debug.WriteLine(result); + } + catch (Exception e) + { + Debug.Print("Exception when calling Onap3gppServiceInstancesApi.deactivate3gppService: " + e.Message ); + } + } + } +} +</code></pre> + </div> + + <div class="tab-pane" id="examples-Onap3gppServiceInstances-deactivate3gppService-0-php"> + <pre class="prettyprint"><code class="language-php"><?php +require_once(__DIR__ . '/vendor/autoload.php'); + +$api_instance = new Swagger\Client\Api\Onap3gppServiceInstancesApi(); +$body = ; // 3gppServiceActivation | +$version = version_example; // String | + +try { + $result = $api_instance->deactivate3gppService($body, $version); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling Onap3gppServiceInstancesApi->deactivate3gppService: ', $e->getMessage(), PHP_EOL; +} +?></code></pre> + </div> + + <div class="tab-pane" id="examples-Onap3gppServiceInstances-deactivate3gppService-0-perl"> + <pre class="prettyprint"><code class="language-perl">use Data::Dumper; +use WWW::SwaggerClient::Configuration; +use WWW::SwaggerClient::Onap3gppServiceInstancesApi; + +my $api_instance = WWW::SwaggerClient::Onap3gppServiceInstancesApi->new(); +my $body = WWW::SwaggerClient::Object::3gppServiceActivation->new(); # 3gppServiceActivation | +my $version = version_example; # String | + +eval { + my $result = $api_instance->deactivate3gppService(body => $body, version => $version); + print Dumper($result); +}; +if ($@) { + warn "Exception when calling Onap3gppServiceInstancesApi->deactivate3gppService: $@\n"; +}</code></pre> + </div> + + <div class="tab-pane" id="examples-Onap3gppServiceInstances-deactivate3gppService-0-python"> + <pre class="prettyprint"><code class="language-python">from __future__ import print_statement +import time +import swagger_client +from swagger_client.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = swagger_client.Onap3gppServiceInstancesApi() +body = # 3gppServiceActivation | +version = version_example # String | + +try: + # Deactivate a 3GPP Service Instance on a version provided + api_response = api_instance.deactivate3gpp_service(body, version) + pprint(api_response) +except ApiException as e: + print("Exception when calling Onap3gppServiceInstancesApi->deactivate3gppService: %s\n" % e)</code></pre> + </div> + </div> + + <h2>Parameters</h2> + + <div class="methodsubtabletitle">Path parameters</div> + <table id="methodsubtable"> + <tr> + <th width="150px">Name</th> + <th>Description</th> + </tr> + <tr><td style="width:150px;">version*</td> +<td> + + + <div id="d2e199_deactivate3gppService_version"> + <div class="json-schema-view"> + <div class="primitive"> + <span class="type"> + String + </span> + + </div> + <div class="inner required"> + Required + </div> + </div> + </div> +</td> +</tr> + + </table> + + + <div class="methodsubtabletitle">Body parameters</div> + <table id="methodsubtable"> + <tr> + <th width="150px">Name</th> + <th>Description</th> + </tr> + <tr><td style="width:150px;">body <span style="color:red;">*</span></td> +<td> + + +<script> +$(document).ready(function() { + var schemaWrapper = { + "in" : "body", + "name" : "body", + "required" : true, + "schema" : { + "$ref" : "#/definitions/3gppServiceActivation" + } +}; + var schema = schemaWrapper.schema; + if (schema.$ref != null) { + schema = defsParser.$refs.get(schema.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema,2,{isBodyParam: true}); + var result = $('#d2e199_deactivate3gppService_body'); + result.empty(); + result.append(view.render()); +}); +</script> +<div id="d2e199_deactivate3gppService_body"></div> +</td> +</tr> + + </table> + + + + <h2>Responses</h2> + <h3> Status: default - successful operation </h3> + + <ul class="nav nav-tabs nav-tabs-examples" > + <li class="active"> + <a data-toggle="tab" href="#responses-deactivate3gppService-default-schema">Schema</a> + </li> + + </ul> + + <div class="tab-content" style='margin-bottom: 10px;'> + <div class="tab-pane active" id="responses-deactivate3gppService-default-schema"> + <div id='responses-deactivate3gppService-default-schema-default' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;"> + <script> + $(document).ready(function() { + var schemaWrapper = { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/3gppServiceResponse" + } +}; + var schema = schemaWrapper.schema; + if (schema.$ref != null) { + schema = defsParser.$refs.get(schema.$ref); + } else { + schemaWrapper.definitions = defs; + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + //console.log(JSON.stringify(schema)); + var view = new JSONSchemaView(schema, 3); + $('#responses-deactivate3gppService-default-schema-data').val(stringify(schema)); + var result = $('#responses-deactivate3gppService-default-schema-default'); + result.empty(); + result.append(view.render()); + }); + </script> + </div> + <input id='responses-deactivate3gppService-default-schema-data' type='hidden' value=''></input> + </div> + </div> + + </article> + </div> + <hr> + <div id="api-Onap3gppServiceInstances-deallocate3gppService"> + <article id="api-Onap3gppServiceInstances-deallocate3gppService-0" data-group="User" data-name="deallocate3gppService" data-version="0"> + <div class="pull-left"> + <h1>deallocate3gppService</h1> + <p>Terminate/Deallocate a 3GPP Service Instance on a version provided</p> + </div> + <div class="pull-right"></div> + <div class="clearfix"></div> + <p></p> + <p class="marked"></p> + <p></p> + <br /> + <pre class="prettyprint language-html prettyprinted" data-type="delete"><code><span class="pln">/onap/so/infra/3gppservices/{version}/deAllocate</span></code></pre> + <p> + <h3>Usage and SDK Samples</h3> + </p> + <ul class="nav nav-tabs nav-tabs-examples"> + <li class="active"><a href="#examples-Onap3gppServiceInstances-deallocate3gppService-0-curl">Curl</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-deallocate3gppService-0-java">Java</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-deallocate3gppService-0-android">Android</a></li> + <!--<li class=""><a href="#examples-Onap3gppServiceInstances-deallocate3gppService-0-groovy">Groovy</a></li>--> + <li class=""><a href="#examples-Onap3gppServiceInstances-deallocate3gppService-0-objc">Obj-C</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-deallocate3gppService-0-javascript">JavaScript</a></li> + <!--<li class=""><a href="#examples-Onap3gppServiceInstances-deallocate3gppService-0-angular">Angular</a></li>--> + <li class=""><a href="#examples-Onap3gppServiceInstances-deallocate3gppService-0-csharp">C#</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-deallocate3gppService-0-php">PHP</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-deallocate3gppService-0-perl">Perl</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-deallocate3gppService-0-python">Python</a></li> + </ul> + + <div class="tab-content"> + <div class="tab-pane active" id="examples-Onap3gppServiceInstances-deallocate3gppService-0-curl"> + <pre class="prettyprint"><code class="language-bsh">curl -X DELETE "http://localhost/onap/so/infra/3gppservices/{version}/deAllocate"</code></pre> + </div> + <div class="tab-pane" id="examples-Onap3gppServiceInstances-deallocate3gppService-0-java"> + <pre class="prettyprint"><code class="language-java">import io.swagger.client.*; +import io.swagger.client.auth.*; +import io.swagger.client.model.*; +import io.swagger.client.api.Onap3gppServiceInstancesApi; + +import java.io.File; +import java.util.*; + +public class Onap3gppServiceInstancesApiExample { + + public static void main(String[] args) { + + Onap3gppServiceInstancesApi apiInstance = new Onap3gppServiceInstancesApi(); + DeAllocate3gppService body = ; // DeAllocate3gppService | + String version = version_example; // String | + try { + 3gppServiceResponse result = apiInstance.deallocate3gppService(body, version); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling Onap3gppServiceInstancesApi#deallocate3gppService"); + e.printStackTrace(); + } + } +}</code></pre> + </div> + + <div class="tab-pane" id="examples-Onap3gppServiceInstances-deallocate3gppService-0-android"> + <pre class="prettyprint"><code class="language-java">import io.swagger.client.api.Onap3gppServiceInstancesApi; + +public class Onap3gppServiceInstancesApiExample { + + public static void main(String[] args) { + Onap3gppServiceInstancesApi apiInstance = new Onap3gppServiceInstancesApi(); + DeAllocate3gppService body = ; // DeAllocate3gppService | + String version = version_example; // String | + try { + 3gppServiceResponse result = apiInstance.deallocate3gppService(body, version); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling Onap3gppServiceInstancesApi#deallocate3gppService"); + e.printStackTrace(); + } + } +}</code></pre> + </div> + <!-- + <div class="tab-pane" id="examples-Onap3gppServiceInstances-deallocate3gppService-0-groovy"> + <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre> + </div> --> + <div class="tab-pane" id="examples-Onap3gppServiceInstances-deallocate3gppService-0-objc"> + <pre class="prettyprint"><code class="language-cpp">DeAllocate3gppService *body = ; // +String *version = version_example; // + +Onap3gppServiceInstancesApi *apiInstance = [[Onap3gppServiceInstancesApi alloc] init]; + +// Terminate/Deallocate a 3GPP Service Instance on a version provided +[apiInstance deallocate3gppServiceWith:body + version:version + completionHandler: ^(3gppServiceResponse output, NSError* error) { + if (output) { + NSLog(@"%@", output); + } + if (error) { + NSLog(@"Error: %@", error); + } + }]; +</code></pre> + </div> + + <div class="tab-pane" id="examples-Onap3gppServiceInstances-deallocate3gppService-0-javascript"> + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); + +var api = new SoGuilinApIs.Onap3gppServiceInstancesApi() + +var body = ; // {DeAllocate3gppService} + +var version = version_example; // {String} + + +var callback = function(error, data, response) { + if (error) { + console.error(error); + } else { + console.log('API called successfully. Returned data: ' + data); + } +}; +api.deallocate3gppService(body, version, callback); +</code></pre> + </div> + + <!--<div class="tab-pane" id="examples-Onap3gppServiceInstances-deallocate3gppService-0-angular"> + <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre> + </div>--> + <div class="tab-pane" id="examples-Onap3gppServiceInstances-deallocate3gppService-0-csharp"> + <pre class="prettyprint"><code class="language-cs">using System; +using System.Diagnostics; +using IO.Swagger.Api; +using IO.Swagger.Client; +using IO.Swagger.Model; + +namespace Example +{ + public class deallocate3gppServiceExample + { + public void main() + { + + var apiInstance = new Onap3gppServiceInstancesApi(); + var body = new DeAllocate3gppService(); // DeAllocate3gppService | + var version = version_example; // String | + + try + { + // Terminate/Deallocate a 3GPP Service Instance on a version provided + 3gppServiceResponse result = apiInstance.deallocate3gppService(body, version); + Debug.WriteLine(result); + } + catch (Exception e) + { + Debug.Print("Exception when calling Onap3gppServiceInstancesApi.deallocate3gppService: " + e.Message ); + } + } + } +} +</code></pre> + </div> + + <div class="tab-pane" id="examples-Onap3gppServiceInstances-deallocate3gppService-0-php"> + <pre class="prettyprint"><code class="language-php"><?php +require_once(__DIR__ . '/vendor/autoload.php'); + +$api_instance = new Swagger\Client\Api\Onap3gppServiceInstancesApi(); +$body = ; // DeAllocate3gppService | +$version = version_example; // String | + +try { + $result = $api_instance->deallocate3gppService($body, $version); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling Onap3gppServiceInstancesApi->deallocate3gppService: ', $e->getMessage(), PHP_EOL; +} +?></code></pre> + </div> + + <div class="tab-pane" id="examples-Onap3gppServiceInstances-deallocate3gppService-0-perl"> + <pre class="prettyprint"><code class="language-perl">use Data::Dumper; +use WWW::SwaggerClient::Configuration; +use WWW::SwaggerClient::Onap3gppServiceInstancesApi; + +my $api_instance = WWW::SwaggerClient::Onap3gppServiceInstancesApi->new(); +my $body = WWW::SwaggerClient::Object::DeAllocate3gppService->new(); # DeAllocate3gppService | +my $version = version_example; # String | + +eval { + my $result = $api_instance->deallocate3gppService(body => $body, version => $version); + print Dumper($result); +}; +if ($@) { + warn "Exception when calling Onap3gppServiceInstancesApi->deallocate3gppService: $@\n"; +}</code></pre> + </div> + + <div class="tab-pane" id="examples-Onap3gppServiceInstances-deallocate3gppService-0-python"> + <pre class="prettyprint"><code class="language-python">from __future__ import print_statement +import time +import swagger_client +from swagger_client.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = swagger_client.Onap3gppServiceInstancesApi() +body = # DeAllocate3gppService | +version = version_example # String | + +try: + # Terminate/Deallocate a 3GPP Service Instance on a version provided + api_response = api_instance.deallocate3gpp_service(body, version) + pprint(api_response) +except ApiException as e: + print("Exception when calling Onap3gppServiceInstancesApi->deallocate3gppService: %s\n" % e)</code></pre> + </div> + </div> + + <h2>Parameters</h2> + + <div class="methodsubtabletitle">Path parameters</div> + <table id="methodsubtable"> + <tr> + <th width="150px">Name</th> + <th>Description</th> + </tr> + <tr><td style="width:150px;">version*</td> +<td> + + + <div id="d2e199_deallocate3gppService_version"> + <div class="json-schema-view"> + <div class="primitive"> + <span class="type"> + String + </span> + + </div> + <div class="inner required"> + Required + </div> + </div> + </div> +</td> +</tr> + + </table> + + + <div class="methodsubtabletitle">Body parameters</div> + <table id="methodsubtable"> + <tr> + <th width="150px">Name</th> + <th>Description</th> + </tr> + <tr><td style="width:150px;">body <span style="color:red;">*</span></td> +<td> + + +<script> +$(document).ready(function() { + var schemaWrapper = { + "in" : "body", + "name" : "body", + "required" : true, + "schema" : { + "$ref" : "#/definitions/DeAllocate3gppService" + } +}; + var schema = schemaWrapper.schema; + if (schema.$ref != null) { + schema = defsParser.$refs.get(schema.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema,2,{isBodyParam: true}); + var result = $('#d2e199_deallocate3gppService_body'); + result.empty(); + result.append(view.render()); +}); +</script> +<div id="d2e199_deallocate3gppService_body"></div> +</td> +</tr> + + </table> + + + + <h2>Responses</h2> + <h3> Status: default - successful operation </h3> + + <ul class="nav nav-tabs nav-tabs-examples" > + <li class="active"> + <a data-toggle="tab" href="#responses-deallocate3gppService-default-schema">Schema</a> + </li> + + </ul> + + <div class="tab-content" style='margin-bottom: 10px;'> + <div class="tab-pane active" id="responses-deallocate3gppService-default-schema"> + <div id='responses-deallocate3gppService-default-schema-default' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;"> + <script> + $(document).ready(function() { + var schemaWrapper = { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/3gppServiceResponse" + } +}; + var schema = schemaWrapper.schema; + if (schema.$ref != null) { + schema = defsParser.$refs.get(schema.$ref); + } else { + schemaWrapper.definitions = defs; + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + //console.log(JSON.stringify(schema)); + var view = new JSONSchemaView(schema, 3); + $('#responses-deallocate3gppService-default-schema-data').val(stringify(schema)); + var result = $('#responses-deallocate3gppService-default-schema-default'); + result.empty(); + result.append(view.render()); + }); + </script> + </div> + <input id='responses-deallocate3gppService-default-schema-data' type='hidden' value=''></input> + </div> + </div> + + </article> + </div> + <hr> + <div id="api-Onap3gppServiceInstances-modify3gppService"> + <article id="api-Onap3gppServiceInstances-modify3gppService-0" data-group="User" data-name="modify3gppService" data-version="0"> + <div class="pull-left"> + <h1>modify3gppService</h1> + <p>Modify a 3GPP Service Instance on a version provided</p> + </div> + <div class="pull-right"></div> + <div class="clearfix"></div> + <p></p> + <p class="marked"></p> + <p></p> + <br /> + <pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/onap/so/infra/3gppservices/{version}/modify</span></code></pre> + <p> + <h3>Usage and SDK Samples</h3> + </p> + <ul class="nav nav-tabs nav-tabs-examples"> + <li class="active"><a href="#examples-Onap3gppServiceInstances-modify3gppService-0-curl">Curl</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-modify3gppService-0-java">Java</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-modify3gppService-0-android">Android</a></li> + <!--<li class=""><a href="#examples-Onap3gppServiceInstances-modify3gppService-0-groovy">Groovy</a></li>--> + <li class=""><a href="#examples-Onap3gppServiceInstances-modify3gppService-0-objc">Obj-C</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-modify3gppService-0-javascript">JavaScript</a></li> + <!--<li class=""><a href="#examples-Onap3gppServiceInstances-modify3gppService-0-angular">Angular</a></li>--> + <li class=""><a href="#examples-Onap3gppServiceInstances-modify3gppService-0-csharp">C#</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-modify3gppService-0-php">PHP</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-modify3gppService-0-perl">Perl</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-modify3gppService-0-python">Python</a></li> + </ul> + + <div class="tab-content"> + <div class="tab-pane active" id="examples-Onap3gppServiceInstances-modify3gppService-0-curl"> + <pre class="prettyprint"><code class="language-bsh">curl -X PUT "http://localhost/onap/so/infra/3gppservices/{version}/modify"</code></pre> + </div> + <div class="tab-pane" id="examples-Onap3gppServiceInstances-modify3gppService-0-java"> + <pre class="prettyprint"><code class="language-java">import io.swagger.client.*; +import io.swagger.client.auth.*; +import io.swagger.client.model.*; +import io.swagger.client.api.Onap3gppServiceInstancesApi; + +import java.io.File; +import java.util.*; + +public class Onap3gppServiceInstancesApiExample { + + public static void main(String[] args) { + + Onap3gppServiceInstancesApi apiInstance = new Onap3gppServiceInstancesApi(); + Modify3gppService body = ; // Modify3gppService | + String version = version_example; // String | + try { + 3gppServiceResponse result = apiInstance.modify3gppService(body, version); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling Onap3gppServiceInstancesApi#modify3gppService"); + e.printStackTrace(); + } + } +}</code></pre> + </div> + + <div class="tab-pane" id="examples-Onap3gppServiceInstances-modify3gppService-0-android"> + <pre class="prettyprint"><code class="language-java">import io.swagger.client.api.Onap3gppServiceInstancesApi; + +public class Onap3gppServiceInstancesApiExample { + + public static void main(String[] args) { + Onap3gppServiceInstancesApi apiInstance = new Onap3gppServiceInstancesApi(); + Modify3gppService body = ; // Modify3gppService | + String version = version_example; // String | + try { + 3gppServiceResponse result = apiInstance.modify3gppService(body, version); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling Onap3gppServiceInstancesApi#modify3gppService"); + e.printStackTrace(); + } + } +}</code></pre> + </div> + <!-- + <div class="tab-pane" id="examples-Onap3gppServiceInstances-modify3gppService-0-groovy"> + <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre> + </div> --> + <div class="tab-pane" id="examples-Onap3gppServiceInstances-modify3gppService-0-objc"> + <pre class="prettyprint"><code class="language-cpp">Modify3gppService *body = ; // +String *version = version_example; // + +Onap3gppServiceInstancesApi *apiInstance = [[Onap3gppServiceInstancesApi alloc] init]; + +// Modify a 3GPP Service Instance on a version provided +[apiInstance modify3gppServiceWith:body + version:version + completionHandler: ^(3gppServiceResponse output, NSError* error) { + if (output) { + NSLog(@"%@", output); + } + if (error) { + NSLog(@"Error: %@", error); + } + }]; +</code></pre> + </div> + + <div class="tab-pane" id="examples-Onap3gppServiceInstances-modify3gppService-0-javascript"> + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); + +var api = new SoGuilinApIs.Onap3gppServiceInstancesApi() + +var body = ; // {Modify3gppService} + +var version = version_example; // {String} + + +var callback = function(error, data, response) { + if (error) { + console.error(error); + } else { + console.log('API called successfully. Returned data: ' + data); + } +}; +api.modify3gppService(body, version, callback); +</code></pre> + </div> + + <!--<div class="tab-pane" id="examples-Onap3gppServiceInstances-modify3gppService-0-angular"> + <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre> + </div>--> + <div class="tab-pane" id="examples-Onap3gppServiceInstances-modify3gppService-0-csharp"> + <pre class="prettyprint"><code class="language-cs">using System; +using System.Diagnostics; +using IO.Swagger.Api; +using IO.Swagger.Client; +using IO.Swagger.Model; + +namespace Example +{ + public class modify3gppServiceExample + { + public void main() + { + + var apiInstance = new Onap3gppServiceInstancesApi(); + var body = new Modify3gppService(); // Modify3gppService | + var version = version_example; // String | + + try + { + // Modify a 3GPP Service Instance on a version provided + 3gppServiceResponse result = apiInstance.modify3gppService(body, version); + Debug.WriteLine(result); + } + catch (Exception e) + { + Debug.Print("Exception when calling Onap3gppServiceInstancesApi.modify3gppService: " + e.Message ); + } + } + } +} +</code></pre> + </div> + + <div class="tab-pane" id="examples-Onap3gppServiceInstances-modify3gppService-0-php"> + <pre class="prettyprint"><code class="language-php"><?php +require_once(__DIR__ . '/vendor/autoload.php'); + +$api_instance = new Swagger\Client\Api\Onap3gppServiceInstancesApi(); +$body = ; // Modify3gppService | +$version = version_example; // String | + +try { + $result = $api_instance->modify3gppService($body, $version); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling Onap3gppServiceInstancesApi->modify3gppService: ', $e->getMessage(), PHP_EOL; +} +?></code></pre> + </div> + + <div class="tab-pane" id="examples-Onap3gppServiceInstances-modify3gppService-0-perl"> + <pre class="prettyprint"><code class="language-perl">use Data::Dumper; +use WWW::SwaggerClient::Configuration; +use WWW::SwaggerClient::Onap3gppServiceInstancesApi; + +my $api_instance = WWW::SwaggerClient::Onap3gppServiceInstancesApi->new(); +my $body = WWW::SwaggerClient::Object::Modify3gppService->new(); # Modify3gppService | +my $version = version_example; # String | + +eval { + my $result = $api_instance->modify3gppService(body => $body, version => $version); + print Dumper($result); +}; +if ($@) { + warn "Exception when calling Onap3gppServiceInstancesApi->modify3gppService: $@\n"; +}</code></pre> + </div> + + <div class="tab-pane" id="examples-Onap3gppServiceInstances-modify3gppService-0-python"> + <pre class="prettyprint"><code class="language-python">from __future__ import print_statement +import time +import swagger_client +from swagger_client.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = swagger_client.Onap3gppServiceInstancesApi() +body = # Modify3gppService | +version = version_example # String | + +try: + # Modify a 3GPP Service Instance on a version provided + api_response = api_instance.modify3gpp_service(body, version) + pprint(api_response) +except ApiException as e: + print("Exception when calling Onap3gppServiceInstancesApi->modify3gppService: %s\n" % e)</code></pre> + </div> + </div> + + <h2>Parameters</h2> + + <div class="methodsubtabletitle">Path parameters</div> + <table id="methodsubtable"> + <tr> + <th width="150px">Name</th> + <th>Description</th> + </tr> + <tr><td style="width:150px;">version*</td> +<td> + + + <div id="d2e199_modify3gppService_version"> + <div class="json-schema-view"> + <div class="primitive"> + <span class="type"> + String + </span> + + </div> + <div class="inner required"> + Required + </div> + </div> + </div> +</td> +</tr> + + </table> + + + <div class="methodsubtabletitle">Body parameters</div> + <table id="methodsubtable"> + <tr> + <th width="150px">Name</th> + <th>Description</th> + </tr> + <tr><td style="width:150px;">body <span style="color:red;">*</span></td> +<td> + + +<script> +$(document).ready(function() { + var schemaWrapper = { + "in" : "body", + "name" : "body", + "required" : true, + "schema" : { + "$ref" : "#/definitions/Modify3gppService" + } +}; + var schema = schemaWrapper.schema; + if (schema.$ref != null) { + schema = defsParser.$refs.get(schema.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema,2,{isBodyParam: true}); + var result = $('#d2e199_modify3gppService_body'); + result.empty(); + result.append(view.render()); +}); +</script> +<div id="d2e199_modify3gppService_body"></div> +</td> +</tr> + + </table> + + + + <h2>Responses</h2> + <h3> Status: default - successful operation </h3> + + <ul class="nav nav-tabs nav-tabs-examples" > + <li class="active"> + <a data-toggle="tab" href="#responses-modify3gppService-default-schema">Schema</a> + </li> + + </ul> + + <div class="tab-content" style='margin-bottom: 10px;'> + <div class="tab-pane active" id="responses-modify3gppService-default-schema"> + <div id='responses-modify3gppService-default-schema-default' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;"> + <script> + $(document).ready(function() { + var schemaWrapper = { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/3gppServiceResponse" + } +}; + var schema = schemaWrapper.schema; + if (schema.$ref != null) { + schema = defsParser.$refs.get(schema.$ref); + } else { + schemaWrapper.definitions = defs; + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + //console.log(JSON.stringify(schema)); + var view = new JSONSchemaView(schema, 3); + $('#responses-modify3gppService-default-schema-data').val(stringify(schema)); + var result = $('#responses-modify3gppService-default-schema-default'); + result.empty(); + result.append(view.render()); + }); + </script> + </div> + <input id='responses-modify3gppService-default-schema-data' type='hidden' value=''></input> + </div> + </div> + + </article> + </div> + <hr> + <div id="api-Onap3gppServiceInstances-querySubnetCapability"> + <article id="api-Onap3gppServiceInstances-querySubnetCapability-0" data-group="User" data-name="querySubnetCapability" data-version="0"> + <div class="pull-left"> + <h1>querySubnetCapability</h1> + <p>Provides subnet capability based on subnet types</p> + </div> + <div class="pull-right"></div> + <div class="clearfix"></div> + <p></p> + <p class="marked"></p> + <p></p> + <br /> + <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/onap/so/infra/3gppservices/{version}/subnetCapabilityQuery</span></code></pre> + <p> + <h3>Usage and SDK Samples</h3> + </p> + <ul class="nav nav-tabs nav-tabs-examples"> + <li class="active"><a href="#examples-Onap3gppServiceInstances-querySubnetCapability-0-curl">Curl</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-querySubnetCapability-0-java">Java</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-querySubnetCapability-0-android">Android</a></li> + <!--<li class=""><a href="#examples-Onap3gppServiceInstances-querySubnetCapability-0-groovy">Groovy</a></li>--> + <li class=""><a href="#examples-Onap3gppServiceInstances-querySubnetCapability-0-objc">Obj-C</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-querySubnetCapability-0-javascript">JavaScript</a></li> + <!--<li class=""><a href="#examples-Onap3gppServiceInstances-querySubnetCapability-0-angular">Angular</a></li>--> + <li class=""><a href="#examples-Onap3gppServiceInstances-querySubnetCapability-0-csharp">C#</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-querySubnetCapability-0-php">PHP</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-querySubnetCapability-0-perl">Perl</a></li> + <li class=""><a href="#examples-Onap3gppServiceInstances-querySubnetCapability-0-python">Python</a></li> + </ul> + + <div class="tab-content"> + <div class="tab-pane active" id="examples-Onap3gppServiceInstances-querySubnetCapability-0-curl"> + <pre class="prettyprint"><code class="language-bsh">curl -X GET "http://localhost/onap/so/infra/3gppservices/{version}/subnetCapabilityQuery"</code></pre> + </div> + <div class="tab-pane" id="examples-Onap3gppServiceInstances-querySubnetCapability-0-java"> + <pre class="prettyprint"><code class="language-java">import io.swagger.client.*; +import io.swagger.client.auth.*; +import io.swagger.client.model.*; +import io.swagger.client.api.Onap3gppServiceInstancesApi; + +import java.io.File; +import java.util.*; + +public class Onap3gppServiceInstancesApiExample { + + public static void main(String[] args) { + + Onap3gppServiceInstancesApi apiInstance = new Onap3gppServiceInstancesApi(); + QuerySubnetCapability body = ; // QuerySubnetCapability | + String version = version_example; // String | + try { + Object result = apiInstance.querySubnetCapability(body, version); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling Onap3gppServiceInstancesApi#querySubnetCapability"); + e.printStackTrace(); + } + } +}</code></pre> + </div> + + <div class="tab-pane" id="examples-Onap3gppServiceInstances-querySubnetCapability-0-android"> + <pre class="prettyprint"><code class="language-java">import io.swagger.client.api.Onap3gppServiceInstancesApi; + +public class Onap3gppServiceInstancesApiExample { + + public static void main(String[] args) { + Onap3gppServiceInstancesApi apiInstance = new Onap3gppServiceInstancesApi(); + QuerySubnetCapability body = ; // QuerySubnetCapability | + String version = version_example; // String | + try { + Object result = apiInstance.querySubnetCapability(body, version); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling Onap3gppServiceInstancesApi#querySubnetCapability"); + e.printStackTrace(); + } + } +}</code></pre> + </div> + <!-- + <div class="tab-pane" id="examples-Onap3gppServiceInstances-querySubnetCapability-0-groovy"> + <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre> + </div> --> + <div class="tab-pane" id="examples-Onap3gppServiceInstances-querySubnetCapability-0-objc"> + <pre class="prettyprint"><code class="language-cpp">QuerySubnetCapability *body = ; // +String *version = version_example; // + +Onap3gppServiceInstancesApi *apiInstance = [[Onap3gppServiceInstancesApi alloc] init]; + +// Provides subnet capability based on subnet types +[apiInstance querySubnetCapabilityWith:body + version:version + completionHandler: ^(Object output, NSError* error) { + if (output) { + NSLog(@"%@", output); + } + if (error) { + NSLog(@"Error: %@", error); + } + }]; +</code></pre> + </div> + + <div class="tab-pane" id="examples-Onap3gppServiceInstances-querySubnetCapability-0-javascript"> + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); + +var api = new SoGuilinApIs.Onap3gppServiceInstancesApi() + +var body = ; // {QuerySubnetCapability} + +var version = version_example; // {String} + + +var callback = function(error, data, response) { + if (error) { + console.error(error); + } else { + console.log('API called successfully. Returned data: ' + data); + } +}; +api.querySubnetCapability(body, version, callback); +</code></pre> + </div> + + <!--<div class="tab-pane" id="examples-Onap3gppServiceInstances-querySubnetCapability-0-angular"> + <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre> + </div>--> + <div class="tab-pane" id="examples-Onap3gppServiceInstances-querySubnetCapability-0-csharp"> + <pre class="prettyprint"><code class="language-cs">using System; +using System.Diagnostics; +using IO.Swagger.Api; +using IO.Swagger.Client; +using IO.Swagger.Model; + +namespace Example +{ + public class querySubnetCapabilityExample + { + public void main() + { + + var apiInstance = new Onap3gppServiceInstancesApi(); + var body = new QuerySubnetCapability(); // QuerySubnetCapability | + var version = version_example; // String | + + try + { + // Provides subnet capability based on subnet types + Object result = apiInstance.querySubnetCapability(body, version); + Debug.WriteLine(result); + } + catch (Exception e) + { + Debug.Print("Exception when calling Onap3gppServiceInstancesApi.querySubnetCapability: " + e.Message ); + } + } + } +} +</code></pre> + </div> + + <div class="tab-pane" id="examples-Onap3gppServiceInstances-querySubnetCapability-0-php"> + <pre class="prettyprint"><code class="language-php"><?php +require_once(__DIR__ . '/vendor/autoload.php'); + +$api_instance = new Swagger\Client\Api\Onap3gppServiceInstancesApi(); +$body = ; // QuerySubnetCapability | +$version = version_example; // String | + +try { + $result = $api_instance->querySubnetCapability($body, $version); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling Onap3gppServiceInstancesApi->querySubnetCapability: ', $e->getMessage(), PHP_EOL; +} +?></code></pre> + </div> + + <div class="tab-pane" id="examples-Onap3gppServiceInstances-querySubnetCapability-0-perl"> + <pre class="prettyprint"><code class="language-perl">use Data::Dumper; +use WWW::SwaggerClient::Configuration; +use WWW::SwaggerClient::Onap3gppServiceInstancesApi; + +my $api_instance = WWW::SwaggerClient::Onap3gppServiceInstancesApi->new(); +my $body = WWW::SwaggerClient::Object::QuerySubnetCapability->new(); # QuerySubnetCapability | +my $version = version_example; # String | + +eval { + my $result = $api_instance->querySubnetCapability(body => $body, version => $version); + print Dumper($result); +}; +if ($@) { + warn "Exception when calling Onap3gppServiceInstancesApi->querySubnetCapability: $@\n"; +}</code></pre> + </div> + + <div class="tab-pane" id="examples-Onap3gppServiceInstances-querySubnetCapability-0-python"> + <pre class="prettyprint"><code class="language-python">from __future__ import print_statement +import time +import swagger_client +from swagger_client.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = swagger_client.Onap3gppServiceInstancesApi() +body = # QuerySubnetCapability | +version = version_example # String | + +try: + # Provides subnet capability based on subnet types + api_response = api_instance.query_subnet_capability(body, version) + pprint(api_response) +except ApiException as e: + print("Exception when calling Onap3gppServiceInstancesApi->querySubnetCapability: %s\n" % e)</code></pre> + </div> + </div> + + <h2>Parameters</h2> + + <div class="methodsubtabletitle">Path parameters</div> + <table id="methodsubtable"> + <tr> + <th width="150px">Name</th> + <th>Description</th> + </tr> + <tr><td style="width:150px;">version*</td> +<td> + + + <div id="d2e199_querySubnetCapability_version"> + <div class="json-schema-view"> + <div class="primitive"> + <span class="type"> + String + </span> + + </div> + <div class="inner required"> + Required + </div> + </div> + </div> +</td> +</tr> + + </table> + + + <div class="methodsubtabletitle">Body parameters</div> + <table id="methodsubtable"> + <tr> + <th width="150px">Name</th> + <th>Description</th> + </tr> + <tr><td style="width:150px;">body <span style="color:red;">*</span></td> +<td> + + +<script> +$(document).ready(function() { + var schemaWrapper = { + "in" : "body", + "name" : "body", + "required" : true, + "schema" : { + "$ref" : "#/definitions/QuerySubnetCapability" + } +}; + var schema = schemaWrapper.schema; + if (schema.$ref != null) { + schema = defsParser.$refs.get(schema.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema,2,{isBodyParam: true}); + var result = $('#d2e199_querySubnetCapability_body'); + result.empty(); + result.append(view.render()); +}); +</script> +<div id="d2e199_querySubnetCapability_body"></div> +</td> +</tr> + + </table> + + + + <h2>Responses</h2> + <h3> Status: default - successful operation with capabilities for the queried subnetTypes </h3> + + <ul class="nav nav-tabs nav-tabs-examples" > + <li class="active"> + <a data-toggle="tab" href="#responses-querySubnetCapability-default-schema">Schema</a> + </li> + + </ul> + + <div class="tab-content" style='margin-bottom: 10px;'> + <div class="tab-pane active" id="responses-querySubnetCapability-default-schema"> + <div id='responses-querySubnetCapability-default-schema-default' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;"> + <script> + $(document).ready(function() { + var schemaWrapper = { + "description" : "successful operation with capabilities for the queried subnetTypes", + "schema" : { + "type" : "object" + } +}; + var schema = schemaWrapper.schema; + if (schema.$ref != null) { + schema = defsParser.$refs.get(schema.$ref); + } else { + schemaWrapper.definitions = defs; + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + //console.log(JSON.stringify(schema)); + var view = new JSONSchemaView(schema, 3); + $('#responses-querySubnetCapability-default-schema-data').val(stringify(schema)); + var result = $('#responses-querySubnetCapability-default-schema-default'); + result.empty(); + result.append(view.render()); + }); + </script> + </div> + <input id='responses-querySubnetCapability-default-schema-data' type='hidden' value=''></input> + </div> + </div> + + </article> + </div> + <hr> + </section> <section id="api-OnapsoinfracloudResources"> <h1>OnapsoinfracloudResources</h1> <div id="api-OnapsoinfracloudResources-activateOperationEnvironment"> @@ -3366,9 +6150,9 @@ OnapsoinfracloudResourcesApi *apiInstance = [[OnapsoinfracloudResourcesApi alloc </div> <div class="tab-pane" id="examples-OnapsoinfracloudResources-activateOperationEnvironment-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfracloudResourcesApi() +var api = new SoGuilinApIs.OnapsoinfracloudResourcesApi() var version = version_example; // {String} @@ -3689,9 +6473,9 @@ OnapsoinfracloudResourcesApi *apiInstance = [[OnapsoinfracloudResourcesApi alloc </div> <div class="tab-pane" id="examples-OnapsoinfracloudResources-createOperationEnvironment-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfracloudResourcesApi() +var api = new SoGuilinApIs.OnapsoinfracloudResourcesApi() var version = version_example; // {String} @@ -3990,9 +6774,9 @@ OnapsoinfracloudResourcesApi *apiInstance = [[OnapsoinfracloudResourcesApi alloc </div> <div class="tab-pane" id="examples-OnapsoinfracloudResources-deactivateOperationEnvironment-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfracloudResourcesApi() +var api = new SoGuilinApIs.OnapsoinfracloudResourcesApi() var version = version_example; // {String} @@ -4312,9 +7096,9 @@ OnapsoinfracloudResourcesRequestsApi *apiInstance = [[OnapsoinfracloudResourcesR </div> <div class="tab-pane" id="examples-OnapsoinfracloudResourcesRequests-getOperationEnvironmentStatusFilter-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfracloudResourcesRequestsApi() +var api = new SoGuilinApIs.OnapsoinfracloudResourcesRequestsApi() var version = version_example; // {String} @@ -4565,9 +7349,9 @@ OnapsoinfracloudResourcesRequestsApi *apiInstance = [[OnapsoinfracloudResourcesR </div> <div class="tab-pane" id="examples-OnapsoinfracloudResourcesRequests-unlockOrchestrationRequestForReqId-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfracloudResourcesRequestsApi() +var api = new SoGuilinApIs.OnapsoinfracloudResourcesRequestsApi() var requestId = requestId_example; // {String} @@ -4789,6 +7573,366 @@ $(document).ready(function() { </div> <hr> </section> + <section id="api-OnapsoinfrainstanceManagement"> + <h1>OnapsoinfrainstanceManagement</h1> + <div id="api-OnapsoinfrainstanceManagement-executeServiceLevelCustomWorkflow"> + <article id="api-OnapsoinfrainstanceManagement-executeServiceLevelCustomWorkflow-0" data-group="User" data-name="executeServiceLevelCustomWorkflow" data-version="0"> + <div class="pull-left"> + <h1>executeServiceLevelCustomWorkflow</h1> + <p>Executing service level custom workflow</p> + </div> + <div class="pull-right"></div> + <div class="clearfix"></div> + <p></p> + <p class="marked"></p> + <p></p> + <br /> + <pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/onap/so/infra/instanceManagement/{version}/serviceInstances/{serviceInstanceId}/workflows/{workflow_UUID}</span></code></pre> + <p> + <h3>Usage and SDK Samples</h3> + </p> + <ul class="nav nav-tabs nav-tabs-examples"> + <li class="active"><a href="#examples-OnapsoinfrainstanceManagement-executeServiceLevelCustomWorkflow-0-curl">Curl</a></li> + <li class=""><a href="#examples-OnapsoinfrainstanceManagement-executeServiceLevelCustomWorkflow-0-java">Java</a></li> + <li class=""><a href="#examples-OnapsoinfrainstanceManagement-executeServiceLevelCustomWorkflow-0-android">Android</a></li> + <!--<li class=""><a href="#examples-OnapsoinfrainstanceManagement-executeServiceLevelCustomWorkflow-0-groovy">Groovy</a></li>--> + <li class=""><a href="#examples-OnapsoinfrainstanceManagement-executeServiceLevelCustomWorkflow-0-objc">Obj-C</a></li> + <li class=""><a href="#examples-OnapsoinfrainstanceManagement-executeServiceLevelCustomWorkflow-0-javascript">JavaScript</a></li> + <!--<li class=""><a href="#examples-OnapsoinfrainstanceManagement-executeServiceLevelCustomWorkflow-0-angular">Angular</a></li>--> + <li class=""><a href="#examples-OnapsoinfrainstanceManagement-executeServiceLevelCustomWorkflow-0-csharp">C#</a></li> + <li class=""><a href="#examples-OnapsoinfrainstanceManagement-executeServiceLevelCustomWorkflow-0-php">PHP</a></li> + <li class=""><a href="#examples-OnapsoinfrainstanceManagement-executeServiceLevelCustomWorkflow-0-perl">Perl</a></li> + <li class=""><a href="#examples-OnapsoinfrainstanceManagement-executeServiceLevelCustomWorkflow-0-python">Python</a></li> + </ul> + + <div class="tab-content"> + <div class="tab-pane active" id="examples-OnapsoinfrainstanceManagement-executeServiceLevelCustomWorkflow-0-curl"> + <pre class="prettyprint"><code class="language-bsh">curl -X POST "http://localhost/onap/so/infra/instanceManagement/{version}/serviceInstances/{serviceInstanceId}/workflows/{workflow_UUID}"</code></pre> + </div> + <div class="tab-pane" id="examples-OnapsoinfrainstanceManagement-executeServiceLevelCustomWorkflow-0-java"> + <pre class="prettyprint"><code class="language-java">import io.swagger.client.*; +import io.swagger.client.auth.*; +import io.swagger.client.model.*; +import io.swagger.client.api.OnapsoinfrainstanceManagementApi; + +import java.io.File; +import java.util.*; + +public class OnapsoinfrainstanceManagementApiExample { + + public static void main(String[] args) { + + OnapsoinfrainstanceManagementApi apiInstance = new OnapsoinfrainstanceManagementApi(); + String version = version_example; // String | + String serviceInstanceId = serviceInstanceId_example; // String | + String workflowUUID = workflowUUID_example; // String | + ServiceLevelWorkflowExecution body = ; // ServiceLevelWorkflowExecution | + try { + apiInstance.executeServiceLevelCustomWorkflow(version, serviceInstanceId, workflowUUID, body); + } catch (ApiException e) { + System.err.println("Exception when calling OnapsoinfrainstanceManagementApi#executeServiceLevelCustomWorkflow"); + e.printStackTrace(); + } + } +}</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfrainstanceManagement-executeServiceLevelCustomWorkflow-0-android"> + <pre class="prettyprint"><code class="language-java">import io.swagger.client.api.OnapsoinfrainstanceManagementApi; + +public class OnapsoinfrainstanceManagementApiExample { + + public static void main(String[] args) { + OnapsoinfrainstanceManagementApi apiInstance = new OnapsoinfrainstanceManagementApi(); + String version = version_example; // String | + String serviceInstanceId = serviceInstanceId_example; // String | + String workflowUUID = workflowUUID_example; // String | + ServiceLevelWorkflowExecution body = ; // ServiceLevelWorkflowExecution | + try { + apiInstance.executeServiceLevelCustomWorkflow(version, serviceInstanceId, workflowUUID, body); + } catch (ApiException e) { + System.err.println("Exception when calling OnapsoinfrainstanceManagementApi#executeServiceLevelCustomWorkflow"); + e.printStackTrace(); + } + } +}</code></pre> + </div> + <!-- + <div class="tab-pane" id="examples-OnapsoinfrainstanceManagement-executeServiceLevelCustomWorkflow-0-groovy"> + <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre> + </div> --> + <div class="tab-pane" id="examples-OnapsoinfrainstanceManagement-executeServiceLevelCustomWorkflow-0-objc"> + <pre class="prettyprint"><code class="language-cpp">String *version = version_example; // +String *serviceInstanceId = serviceInstanceId_example; // +String *workflowUUID = workflowUUID_example; // +ServiceLevelWorkflowExecution *body = ; // (optional) + +OnapsoinfrainstanceManagementApi *apiInstance = [[OnapsoinfrainstanceManagementApi alloc] init]; + +// Executing service level custom workflow +[apiInstance executeServiceLevelCustomWorkflowWith:version + serviceInstanceId:serviceInstanceId + workflowUUID:workflowUUID + body:body + completionHandler: ^(NSError* error) { + if (error) { + NSLog(@"Error: %@", error); + } + }]; +</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfrainstanceManagement-executeServiceLevelCustomWorkflow-0-javascript"> + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); + +var api = new SoGuilinApIs.OnapsoinfrainstanceManagementApi() + +var version = version_example; // {String} + +var serviceInstanceId = serviceInstanceId_example; // {String} + +var workflowUUID = workflowUUID_example; // {String} + +var opts = { + 'body': // {ServiceLevelWorkflowExecution} +}; + +var callback = function(error, data, response) { + if (error) { + console.error(error); + } else { + console.log('API called successfully.'); + } +}; +api.executeServiceLevelCustomWorkflow(version, serviceInstanceId, workflowUUID, opts, callback); +</code></pre> + </div> + + <!--<div class="tab-pane" id="examples-OnapsoinfrainstanceManagement-executeServiceLevelCustomWorkflow-0-angular"> + <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre> + </div>--> + <div class="tab-pane" id="examples-OnapsoinfrainstanceManagement-executeServiceLevelCustomWorkflow-0-csharp"> + <pre class="prettyprint"><code class="language-cs">using System; +using System.Diagnostics; +using IO.Swagger.Api; +using IO.Swagger.Client; +using IO.Swagger.Model; + +namespace Example +{ + public class executeServiceLevelCustomWorkflowExample + { + public void main() + { + + var apiInstance = new OnapsoinfrainstanceManagementApi(); + var version = version_example; // String | + var serviceInstanceId = serviceInstanceId_example; // String | + var workflowUUID = workflowUUID_example; // String | + var body = new ServiceLevelWorkflowExecution(); // ServiceLevelWorkflowExecution | (optional) + + try + { + // Executing service level custom workflow + apiInstance.executeServiceLevelCustomWorkflow(version, serviceInstanceId, workflowUUID, body); + } + catch (Exception e) + { + Debug.Print("Exception when calling OnapsoinfrainstanceManagementApi.executeServiceLevelCustomWorkflow: " + e.Message ); + } + } + } +} +</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfrainstanceManagement-executeServiceLevelCustomWorkflow-0-php"> + <pre class="prettyprint"><code class="language-php"><?php +require_once(__DIR__ . '/vendor/autoload.php'); + +$api_instance = new Swagger\Client\Api\OnapsoinfrainstanceManagementApi(); +$version = version_example; // String | +$serviceInstanceId = serviceInstanceId_example; // String | +$workflowUUID = workflowUUID_example; // String | +$body = ; // ServiceLevelWorkflowExecution | + +try { + $api_instance->executeServiceLevelCustomWorkflow($version, $serviceInstanceId, $workflowUUID, $body); +} catch (Exception $e) { + echo 'Exception when calling OnapsoinfrainstanceManagementApi->executeServiceLevelCustomWorkflow: ', $e->getMessage(), PHP_EOL; +} +?></code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfrainstanceManagement-executeServiceLevelCustomWorkflow-0-perl"> + <pre class="prettyprint"><code class="language-perl">use Data::Dumper; +use WWW::SwaggerClient::Configuration; +use WWW::SwaggerClient::OnapsoinfrainstanceManagementApi; + +my $api_instance = WWW::SwaggerClient::OnapsoinfrainstanceManagementApi->new(); +my $version = version_example; # String | +my $serviceInstanceId = serviceInstanceId_example; # String | +my $workflowUUID = workflowUUID_example; # String | +my $body = WWW::SwaggerClient::Object::ServiceLevelWorkflowExecution->new(); # ServiceLevelWorkflowExecution | + +eval { + $api_instance->executeServiceLevelCustomWorkflow(version => $version, serviceInstanceId => $serviceInstanceId, workflowUUID => $workflowUUID, body => $body); +}; +if ($@) { + warn "Exception when calling OnapsoinfrainstanceManagementApi->executeServiceLevelCustomWorkflow: $@\n"; +}</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfrainstanceManagement-executeServiceLevelCustomWorkflow-0-python"> + <pre class="prettyprint"><code class="language-python">from __future__ import print_statement +import time +import swagger_client +from swagger_client.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = swagger_client.OnapsoinfrainstanceManagementApi() +version = version_example # String | +serviceInstanceId = serviceInstanceId_example # String | +workflowUUID = workflowUUID_example # String | +body = # ServiceLevelWorkflowExecution | (optional) + +try: + # Executing service level custom workflow + api_instance.execute_service_level_custom_workflow(version, serviceInstanceId, workflowUUID, body=body) +except ApiException as e: + print("Exception when calling OnapsoinfrainstanceManagementApi->executeServiceLevelCustomWorkflow: %s\n" % e)</code></pre> + </div> + </div> + + <h2>Parameters</h2> + + <div class="methodsubtabletitle">Path parameters</div> + <table id="methodsubtable"> + <tr> + <th width="150px">Name</th> + <th>Description</th> + </tr> + <tr><td style="width:150px;">version*</td> +<td> + + + <div id="d2e199_executeServiceLevelCustomWorkflow_version"> + <div class="json-schema-view"> + <div class="primitive"> + <span class="type"> + String + </span> + + </div> + <div class="inner required"> + Required + </div> + </div> + </div> +</td> +</tr> + + <tr><td style="width:150px;">serviceInstanceId*</td> +<td> + + + <div id="d2e199_executeServiceLevelCustomWorkflow_serviceInstanceId"> + <div class="json-schema-view"> + <div class="primitive"> + <span class="type"> + String + </span> + + </div> + <div class="inner required"> + Required + </div> + </div> + </div> +</td> +</tr> + + <tr><td style="width:150px;">workflow_UUID*</td> +<td> + + + <div id="d2e199_executeServiceLevelCustomWorkflow_workflowUUID"> + <div class="json-schema-view"> + <div class="primitive"> + <span class="type"> + String + </span> + + </div> + <div class="inner required"> + Required + </div> + </div> + </div> +</td> +</tr> + + </table> + + + <div class="methodsubtabletitle">Body parameters</div> + <table id="methodsubtable"> + <tr> + <th width="150px">Name</th> + <th>Description</th> + </tr> + <tr><td style="width:150px;">body </td> +<td> + + +<script> +$(document).ready(function() { + var schemaWrapper = { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "$ref" : "#/definitions/ServiceLevelWorkflowExecution" + } +}; + var schema = schemaWrapper.schema; + if (schema.$ref != null) { + schema = defsParser.$refs.get(schema.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema,2,{isBodyParam: true}); + var result = $('#d2e199_executeServiceLevelCustomWorkflow_body'); + result.empty(); + result.append(view.render()); +}); +</script> +<div id="d2e199_executeServiceLevelCustomWorkflow_body"></div> +</td> +</tr> + + </table> + + + + <h2>Responses</h2> + <h3> Status: default - successful operation </h3> + + <ul class="nav nav-tabs nav-tabs-examples" > + </ul> + + <div class="tab-content" style='margin-bottom: 10px;'> + </div> + + </article> + </div> + <hr> + </section> <section id="api-OnapsoinframodelDistributions"> <h1>OnapsoinframodelDistributions</h1> <div id="api-OnapsoinframodelDistributions-updateModelDistributionStatus"> @@ -4895,9 +8039,9 @@ OnapsoinframodelDistributionsApi *apiInstance = [[OnapsoinframodelDistributionsA </div> <div class="tab-pane" id="examples-OnapsoinframodelDistributions-updateModelDistributionStatus-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinframodelDistributionsApi() +var api = new SoGuilinApIs.OnapsoinframodelDistributionsApi() var version = version_example; // {String} @@ -5217,9 +8361,9 @@ OnapsoinfraorchestrationRequestsApi *apiInstance = [[OnapsoinfraorchestrationReq </div> <div class="tab-pane" id="examples-OnapsoinfraorchestrationRequests-getOrchestrationRequest-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfraorchestrationRequestsApi() +var api = new SoGuilinApIs.OnapsoinfraorchestrationRequestsApi() var version = version_example; // {String} @@ -5466,9 +8610,9 @@ OnapsoinfraorchestrationRequestsApi *apiInstance = [[OnapsoinfraorchestrationReq </div> <div class="tab-pane" id="examples-OnapsoinfraorchestrationRequests-getOrchestrationRequestForReqId-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfraorchestrationRequestsApi() +var api = new SoGuilinApIs.OnapsoinfraorchestrationRequestsApi() var requestId = requestId_example; // {String} @@ -5745,9 +8889,9 @@ OnapsoinfraorchestrationRequestsApi *apiInstance = [[OnapsoinfraorchestrationReq </div> <div class="tab-pane" id="examples-OnapsoinfraorchestrationRequests-unlockOrchestrationRequest-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfraorchestrationRequestsApi() +var api = new SoGuilinApIs.OnapsoinfraorchestrationRequestsApi() var requestId = requestId_example; // {String} @@ -5969,6 +9113,2082 @@ $(document).ready(function() { </div> <hr> </section> + <section id="api-OnapsoinfraorchestrationTasks"> + <h1>OnapsoinfraorchestrationTasks</h1> + <div id="api-OnapsoinfraorchestrationTasks-abortOrchestrationTask"> + <article id="api-OnapsoinfraorchestrationTasks-abortOrchestrationTask-0" data-group="User" data-name="abortOrchestrationTask" data-version="0"> + <div class="pull-left"> + <h1>abortOrchestrationTask</h1> + <p>abort orchestrationTask for a given taskId</p> + </div> + <div class="pull-right"></div> + <div class="clearfix"></div> + <p></p> + <p class="marked"></p> + <p></p> + <br /> + <pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/onap/so/infra/orchestrationTasks/{version}/{taskId}/abort</span></code></pre> + <p> + <h3>Usage and SDK Samples</h3> + </p> + <ul class="nav nav-tabs nav-tabs-examples"> + <li class="active"><a href="#examples-OnapsoinfraorchestrationTasks-abortOrchestrationTask-0-curl">Curl</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-abortOrchestrationTask-0-java">Java</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-abortOrchestrationTask-0-android">Android</a></li> + <!--<li class=""><a href="#examples-OnapsoinfraorchestrationTasks-abortOrchestrationTask-0-groovy">Groovy</a></li>--> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-abortOrchestrationTask-0-objc">Obj-C</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-abortOrchestrationTask-0-javascript">JavaScript</a></li> + <!--<li class=""><a href="#examples-OnapsoinfraorchestrationTasks-abortOrchestrationTask-0-angular">Angular</a></li>--> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-abortOrchestrationTask-0-csharp">C#</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-abortOrchestrationTask-0-php">PHP</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-abortOrchestrationTask-0-perl">Perl</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-abortOrchestrationTask-0-python">Python</a></li> + </ul> + + <div class="tab-content"> + <div class="tab-pane active" id="examples-OnapsoinfraorchestrationTasks-abortOrchestrationTask-0-curl"> + <pre class="prettyprint"><code class="language-bsh">curl -X POST "http://localhost/onap/so/infra/orchestrationTasks/{version}/{taskId}/abort"</code></pre> + </div> + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-abortOrchestrationTask-0-java"> + <pre class="prettyprint"><code class="language-java">import io.swagger.client.*; +import io.swagger.client.auth.*; +import io.swagger.client.model.*; +import io.swagger.client.api.OnapsoinfraorchestrationTasksApi; + +import java.io.File; +import java.util.*; + +public class OnapsoinfraorchestrationTasksApiExample { + + public static void main(String[] args) { + + OnapsoinfraorchestrationTasksApi apiInstance = new OnapsoinfraorchestrationTasksApi(); + String taskId = taskId_example; // String | + String version = version_example; // String | + String body = body_example; // String | + try { + apiInstance.abortOrchestrationTask(taskId, version, body); + } catch (ApiException e) { + System.err.println("Exception when calling OnapsoinfraorchestrationTasksApi#abortOrchestrationTask"); + e.printStackTrace(); + } + } +}</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-abortOrchestrationTask-0-android"> + <pre class="prettyprint"><code class="language-java">import io.swagger.client.api.OnapsoinfraorchestrationTasksApi; + +public class OnapsoinfraorchestrationTasksApiExample { + + public static void main(String[] args) { + OnapsoinfraorchestrationTasksApi apiInstance = new OnapsoinfraorchestrationTasksApi(); + String taskId = taskId_example; // String | + String version = version_example; // String | + String body = body_example; // String | + try { + apiInstance.abortOrchestrationTask(taskId, version, body); + } catch (ApiException e) { + System.err.println("Exception when calling OnapsoinfraorchestrationTasksApi#abortOrchestrationTask"); + e.printStackTrace(); + } + } +}</code></pre> + </div> + <!-- + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-abortOrchestrationTask-0-groovy"> + <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre> + </div> --> + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-abortOrchestrationTask-0-objc"> + <pre class="prettyprint"><code class="language-cpp">String *taskId = taskId_example; // +String *version = version_example; // +String *body = body_example; // (optional) + +OnapsoinfraorchestrationTasksApi *apiInstance = [[OnapsoinfraorchestrationTasksApi alloc] init]; + +// abort orchestrationTask for a given taskId +[apiInstance abortOrchestrationTaskWith:taskId + version:version + body:body + completionHandler: ^(NSError* error) { + if (error) { + NSLog(@"Error: %@", error); + } + }]; +</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-abortOrchestrationTask-0-javascript"> + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); + +var api = new SoGuilinApIs.OnapsoinfraorchestrationTasksApi() + +var taskId = taskId_example; // {String} + +var version = version_example; // {String} + +var opts = { + 'body': body_example // {String} +}; + +var callback = function(error, data, response) { + if (error) { + console.error(error); + } else { + console.log('API called successfully.'); + } +}; +api.abortOrchestrationTask(taskId, version, opts, callback); +</code></pre> + </div> + + <!--<div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-abortOrchestrationTask-0-angular"> + <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre> + </div>--> + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-abortOrchestrationTask-0-csharp"> + <pre class="prettyprint"><code class="language-cs">using System; +using System.Diagnostics; +using IO.Swagger.Api; +using IO.Swagger.Client; +using IO.Swagger.Model; + +namespace Example +{ + public class abortOrchestrationTaskExample + { + public void main() + { + + var apiInstance = new OnapsoinfraorchestrationTasksApi(); + var taskId = taskId_example; // String | + var version = version_example; // String | + var body = body_example; // String | (optional) + + try + { + // abort orchestrationTask for a given taskId + apiInstance.abortOrchestrationTask(taskId, version, body); + } + catch (Exception e) + { + Debug.Print("Exception when calling OnapsoinfraorchestrationTasksApi.abortOrchestrationTask: " + e.Message ); + } + } + } +} +</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-abortOrchestrationTask-0-php"> + <pre class="prettyprint"><code class="language-php"><?php +require_once(__DIR__ . '/vendor/autoload.php'); + +$api_instance = new Swagger\Client\Api\OnapsoinfraorchestrationTasksApi(); +$taskId = taskId_example; // String | +$version = version_example; // String | +$body = body_example; // String | + +try { + $api_instance->abortOrchestrationTask($taskId, $version, $body); +} catch (Exception $e) { + echo 'Exception when calling OnapsoinfraorchestrationTasksApi->abortOrchestrationTask: ', $e->getMessage(), PHP_EOL; +} +?></code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-abortOrchestrationTask-0-perl"> + <pre class="prettyprint"><code class="language-perl">use Data::Dumper; +use WWW::SwaggerClient::Configuration; +use WWW::SwaggerClient::OnapsoinfraorchestrationTasksApi; + +my $api_instance = WWW::SwaggerClient::OnapsoinfraorchestrationTasksApi->new(); +my $taskId = taskId_example; # String | +my $version = version_example; # String | +my $body = WWW::SwaggerClient::Object::String->new(); # String | + +eval { + $api_instance->abortOrchestrationTask(taskId => $taskId, version => $version, body => $body); +}; +if ($@) { + warn "Exception when calling OnapsoinfraorchestrationTasksApi->abortOrchestrationTask: $@\n"; +}</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-abortOrchestrationTask-0-python"> + <pre class="prettyprint"><code class="language-python">from __future__ import print_statement +import time +import swagger_client +from swagger_client.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = swagger_client.OnapsoinfraorchestrationTasksApi() +taskId = taskId_example # String | +version = version_example # String | +body = body_example # String | (optional) + +try: + # abort orchestrationTask for a given taskId + api_instance.abort_orchestration_task(taskId, version, body=body) +except ApiException as e: + print("Exception when calling OnapsoinfraorchestrationTasksApi->abortOrchestrationTask: %s\n" % e)</code></pre> + </div> + </div> + + <h2>Parameters</h2> + + <div class="methodsubtabletitle">Path parameters</div> + <table id="methodsubtable"> + <tr> + <th width="150px">Name</th> + <th>Description</th> + </tr> + <tr><td style="width:150px;">taskId*</td> +<td> + + + <div id="d2e199_abortOrchestrationTask_taskId"> + <div class="json-schema-view"> + <div class="primitive"> + <span class="type"> + String + </span> + + </div> + <div class="inner required"> + Required + </div> + </div> + </div> +</td> +</tr> + + <tr><td style="width:150px;">version*</td> +<td> + + + <div id="d2e199_abortOrchestrationTask_version"> + <div class="json-schema-view"> + <div class="primitive"> + <span class="type"> + String + </span> + + </div> + <div class="inner required"> + Required + </div> + </div> + </div> +</td> +</tr> + + </table> + + + <div class="methodsubtabletitle">Body parameters</div> + <table id="methodsubtable"> + <tr> + <th width="150px">Name</th> + <th>Description</th> + </tr> + <tr><td style="width:150px;">body </td> +<td> + + +<script> +$(document).ready(function() { + var schemaWrapper = { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "type" : "string" + } +}; + var schema = schemaWrapper.schema; + if (schema.$ref != null) { + schema = defsParser.$refs.get(schema.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema,2,{isBodyParam: true}); + var result = $('#d2e199_abortOrchestrationTask_body'); + result.empty(); + result.append(view.render()); +}); +</script> +<div id="d2e199_abortOrchestrationTask_body"></div> +</td> +</tr> + + </table> + + + + <h2>Responses</h2> + <h3> Status: default - successful operation </h3> + + <ul class="nav nav-tabs nav-tabs-examples" > + </ul> + + <div class="tab-content" style='margin-bottom: 10px;'> + </div> + + </article> + </div> + <hr> + <div id="api-OnapsoinfraorchestrationTasks-commitOrchestrationTask"> + <article id="api-OnapsoinfraorchestrationTasks-commitOrchestrationTask-0" data-group="User" data-name="commitOrchestrationTask" data-version="0"> + <div class="pull-left"> + <h1>commitOrchestrationTask</h1> + <p>commit orchestrationTask for a given taskId</p> + </div> + <div class="pull-right"></div> + <div class="clearfix"></div> + <p></p> + <p class="marked"></p> + <p></p> + <br /> + <pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/onap/so/infra/orchestrationTasks/{version}/{taskId}/commit</span></code></pre> + <p> + <h3>Usage and SDK Samples</h3> + </p> + <ul class="nav nav-tabs nav-tabs-examples"> + <li class="active"><a href="#examples-OnapsoinfraorchestrationTasks-commitOrchestrationTask-0-curl">Curl</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-commitOrchestrationTask-0-java">Java</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-commitOrchestrationTask-0-android">Android</a></li> + <!--<li class=""><a href="#examples-OnapsoinfraorchestrationTasks-commitOrchestrationTask-0-groovy">Groovy</a></li>--> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-commitOrchestrationTask-0-objc">Obj-C</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-commitOrchestrationTask-0-javascript">JavaScript</a></li> + <!--<li class=""><a href="#examples-OnapsoinfraorchestrationTasks-commitOrchestrationTask-0-angular">Angular</a></li>--> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-commitOrchestrationTask-0-csharp">C#</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-commitOrchestrationTask-0-php">PHP</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-commitOrchestrationTask-0-perl">Perl</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-commitOrchestrationTask-0-python">Python</a></li> + </ul> + + <div class="tab-content"> + <div class="tab-pane active" id="examples-OnapsoinfraorchestrationTasks-commitOrchestrationTask-0-curl"> + <pre class="prettyprint"><code class="language-bsh">curl -X POST "http://localhost/onap/so/infra/orchestrationTasks/{version}/{taskId}/commit"</code></pre> + </div> + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-commitOrchestrationTask-0-java"> + <pre class="prettyprint"><code class="language-java">import io.swagger.client.*; +import io.swagger.client.auth.*; +import io.swagger.client.model.*; +import io.swagger.client.api.OnapsoinfraorchestrationTasksApi; + +import java.io.File; +import java.util.*; + +public class OnapsoinfraorchestrationTasksApiExample { + + public static void main(String[] args) { + + OnapsoinfraorchestrationTasksApi apiInstance = new OnapsoinfraorchestrationTasksApi(); + String taskId = taskId_example; // String | + String version = version_example; // String | + String body = body_example; // String | + try { + apiInstance.commitOrchestrationTask(taskId, version, body); + } catch (ApiException e) { + System.err.println("Exception when calling OnapsoinfraorchestrationTasksApi#commitOrchestrationTask"); + e.printStackTrace(); + } + } +}</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-commitOrchestrationTask-0-android"> + <pre class="prettyprint"><code class="language-java">import io.swagger.client.api.OnapsoinfraorchestrationTasksApi; + +public class OnapsoinfraorchestrationTasksApiExample { + + public static void main(String[] args) { + OnapsoinfraorchestrationTasksApi apiInstance = new OnapsoinfraorchestrationTasksApi(); + String taskId = taskId_example; // String | + String version = version_example; // String | + String body = body_example; // String | + try { + apiInstance.commitOrchestrationTask(taskId, version, body); + } catch (ApiException e) { + System.err.println("Exception when calling OnapsoinfraorchestrationTasksApi#commitOrchestrationTask"); + e.printStackTrace(); + } + } +}</code></pre> + </div> + <!-- + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-commitOrchestrationTask-0-groovy"> + <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre> + </div> --> + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-commitOrchestrationTask-0-objc"> + <pre class="prettyprint"><code class="language-cpp">String *taskId = taskId_example; // +String *version = version_example; // +String *body = body_example; // (optional) + +OnapsoinfraorchestrationTasksApi *apiInstance = [[OnapsoinfraorchestrationTasksApi alloc] init]; + +// commit orchestrationTask for a given taskId +[apiInstance commitOrchestrationTaskWith:taskId + version:version + body:body + completionHandler: ^(NSError* error) { + if (error) { + NSLog(@"Error: %@", error); + } + }]; +</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-commitOrchestrationTask-0-javascript"> + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); + +var api = new SoGuilinApIs.OnapsoinfraorchestrationTasksApi() + +var taskId = taskId_example; // {String} + +var version = version_example; // {String} + +var opts = { + 'body': body_example // {String} +}; + +var callback = function(error, data, response) { + if (error) { + console.error(error); + } else { + console.log('API called successfully.'); + } +}; +api.commitOrchestrationTask(taskId, version, opts, callback); +</code></pre> + </div> + + <!--<div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-commitOrchestrationTask-0-angular"> + <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre> + </div>--> + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-commitOrchestrationTask-0-csharp"> + <pre class="prettyprint"><code class="language-cs">using System; +using System.Diagnostics; +using IO.Swagger.Api; +using IO.Swagger.Client; +using IO.Swagger.Model; + +namespace Example +{ + public class commitOrchestrationTaskExample + { + public void main() + { + + var apiInstance = new OnapsoinfraorchestrationTasksApi(); + var taskId = taskId_example; // String | + var version = version_example; // String | + var body = body_example; // String | (optional) + + try + { + // commit orchestrationTask for a given taskId + apiInstance.commitOrchestrationTask(taskId, version, body); + } + catch (Exception e) + { + Debug.Print("Exception when calling OnapsoinfraorchestrationTasksApi.commitOrchestrationTask: " + e.Message ); + } + } + } +} +</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-commitOrchestrationTask-0-php"> + <pre class="prettyprint"><code class="language-php"><?php +require_once(__DIR__ . '/vendor/autoload.php'); + +$api_instance = new Swagger\Client\Api\OnapsoinfraorchestrationTasksApi(); +$taskId = taskId_example; // String | +$version = version_example; // String | +$body = body_example; // String | + +try { + $api_instance->commitOrchestrationTask($taskId, $version, $body); +} catch (Exception $e) { + echo 'Exception when calling OnapsoinfraorchestrationTasksApi->commitOrchestrationTask: ', $e->getMessage(), PHP_EOL; +} +?></code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-commitOrchestrationTask-0-perl"> + <pre class="prettyprint"><code class="language-perl">use Data::Dumper; +use WWW::SwaggerClient::Configuration; +use WWW::SwaggerClient::OnapsoinfraorchestrationTasksApi; + +my $api_instance = WWW::SwaggerClient::OnapsoinfraorchestrationTasksApi->new(); +my $taskId = taskId_example; # String | +my $version = version_example; # String | +my $body = WWW::SwaggerClient::Object::String->new(); # String | + +eval { + $api_instance->commitOrchestrationTask(taskId => $taskId, version => $version, body => $body); +}; +if ($@) { + warn "Exception when calling OnapsoinfraorchestrationTasksApi->commitOrchestrationTask: $@\n"; +}</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-commitOrchestrationTask-0-python"> + <pre class="prettyprint"><code class="language-python">from __future__ import print_statement +import time +import swagger_client +from swagger_client.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = swagger_client.OnapsoinfraorchestrationTasksApi() +taskId = taskId_example # String | +version = version_example # String | +body = body_example # String | (optional) + +try: + # commit orchestrationTask for a given taskId + api_instance.commit_orchestration_task(taskId, version, body=body) +except ApiException as e: + print("Exception when calling OnapsoinfraorchestrationTasksApi->commitOrchestrationTask: %s\n" % e)</code></pre> + </div> + </div> + + <h2>Parameters</h2> + + <div class="methodsubtabletitle">Path parameters</div> + <table id="methodsubtable"> + <tr> + <th width="150px">Name</th> + <th>Description</th> + </tr> + <tr><td style="width:150px;">taskId*</td> +<td> + + + <div id="d2e199_commitOrchestrationTask_taskId"> + <div class="json-schema-view"> + <div class="primitive"> + <span class="type"> + String + </span> + + </div> + <div class="inner required"> + Required + </div> + </div> + </div> +</td> +</tr> + + <tr><td style="width:150px;">version*</td> +<td> + + + <div id="d2e199_commitOrchestrationTask_version"> + <div class="json-schema-view"> + <div class="primitive"> + <span class="type"> + String + </span> + + </div> + <div class="inner required"> + Required + </div> + </div> + </div> +</td> +</tr> + + </table> + + + <div class="methodsubtabletitle">Body parameters</div> + <table id="methodsubtable"> + <tr> + <th width="150px">Name</th> + <th>Description</th> + </tr> + <tr><td style="width:150px;">body </td> +<td> + + +<script> +$(document).ready(function() { + var schemaWrapper = { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "type" : "string" + } +}; + var schema = schemaWrapper.schema; + if (schema.$ref != null) { + schema = defsParser.$refs.get(schema.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema,2,{isBodyParam: true}); + var result = $('#d2e199_commitOrchestrationTask_body'); + result.empty(); + result.append(view.render()); +}); +</script> +<div id="d2e199_commitOrchestrationTask_body"></div> +</td> +</tr> + + </table> + + + + <h2>Responses</h2> + <h3> Status: default - successful operation </h3> + + <ul class="nav nav-tabs nav-tabs-examples" > + </ul> + + <div class="tab-content" style='margin-bottom: 10px;'> + </div> + + </article> + </div> + <hr> + <div id="api-OnapsoinfraorchestrationTasks-createOrchestrationTask"> + <article id="api-OnapsoinfraorchestrationTasks-createOrchestrationTask-0" data-group="User" data-name="createOrchestrationTask" data-version="0"> + <div class="pull-left"> + <h1>createOrchestrationTask</h1> + <p>Create an orchestrationTask</p> + </div> + <div class="pull-right"></div> + <div class="clearfix"></div> + <p></p> + <p class="marked"></p> + <p></p> + <br /> + <pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/onap/so/infra/orchestrationTasks/{version}</span></code></pre> + <p> + <h3>Usage and SDK Samples</h3> + </p> + <ul class="nav nav-tabs nav-tabs-examples"> + <li class="active"><a href="#examples-OnapsoinfraorchestrationTasks-createOrchestrationTask-0-curl">Curl</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-createOrchestrationTask-0-java">Java</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-createOrchestrationTask-0-android">Android</a></li> + <!--<li class=""><a href="#examples-OnapsoinfraorchestrationTasks-createOrchestrationTask-0-groovy">Groovy</a></li>--> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-createOrchestrationTask-0-objc">Obj-C</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-createOrchestrationTask-0-javascript">JavaScript</a></li> + <!--<li class=""><a href="#examples-OnapsoinfraorchestrationTasks-createOrchestrationTask-0-angular">Angular</a></li>--> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-createOrchestrationTask-0-csharp">C#</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-createOrchestrationTask-0-php">PHP</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-createOrchestrationTask-0-perl">Perl</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-createOrchestrationTask-0-python">Python</a></li> + </ul> + + <div class="tab-content"> + <div class="tab-pane active" id="examples-OnapsoinfraorchestrationTasks-createOrchestrationTask-0-curl"> + <pre class="prettyprint"><code class="language-bsh">curl -X POST "http://localhost/onap/so/infra/orchestrationTasks/{version}"</code></pre> + </div> + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-createOrchestrationTask-0-java"> + <pre class="prettyprint"><code class="language-java">import io.swagger.client.*; +import io.swagger.client.auth.*; +import io.swagger.client.model.*; +import io.swagger.client.api.OnapsoinfraorchestrationTasksApi; + +import java.io.File; +import java.util.*; + +public class OnapsoinfraorchestrationTasksApiExample { + + public static void main(String[] args) { + + OnapsoinfraorchestrationTasksApi apiInstance = new OnapsoinfraorchestrationTasksApi(); + String version = version_example; // String | + String body = body_example; // String | + try { + apiInstance.createOrchestrationTask(version, body); + } catch (ApiException e) { + System.err.println("Exception when calling OnapsoinfraorchestrationTasksApi#createOrchestrationTask"); + e.printStackTrace(); + } + } +}</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-createOrchestrationTask-0-android"> + <pre class="prettyprint"><code class="language-java">import io.swagger.client.api.OnapsoinfraorchestrationTasksApi; + +public class OnapsoinfraorchestrationTasksApiExample { + + public static void main(String[] args) { + OnapsoinfraorchestrationTasksApi apiInstance = new OnapsoinfraorchestrationTasksApi(); + String version = version_example; // String | + String body = body_example; // String | + try { + apiInstance.createOrchestrationTask(version, body); + } catch (ApiException e) { + System.err.println("Exception when calling OnapsoinfraorchestrationTasksApi#createOrchestrationTask"); + e.printStackTrace(); + } + } +}</code></pre> + </div> + <!-- + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-createOrchestrationTask-0-groovy"> + <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre> + </div> --> + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-createOrchestrationTask-0-objc"> + <pre class="prettyprint"><code class="language-cpp">String *version = version_example; // +String *body = body_example; // (optional) + +OnapsoinfraorchestrationTasksApi *apiInstance = [[OnapsoinfraorchestrationTasksApi alloc] init]; + +// Create an orchestrationTask +[apiInstance createOrchestrationTaskWith:version + body:body + completionHandler: ^(NSError* error) { + if (error) { + NSLog(@"Error: %@", error); + } + }]; +</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-createOrchestrationTask-0-javascript"> + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); + +var api = new SoGuilinApIs.OnapsoinfraorchestrationTasksApi() + +var version = version_example; // {String} + +var opts = { + 'body': body_example // {String} +}; + +var callback = function(error, data, response) { + if (error) { + console.error(error); + } else { + console.log('API called successfully.'); + } +}; +api.createOrchestrationTask(version, opts, callback); +</code></pre> + </div> + + <!--<div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-createOrchestrationTask-0-angular"> + <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre> + </div>--> + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-createOrchestrationTask-0-csharp"> + <pre class="prettyprint"><code class="language-cs">using System; +using System.Diagnostics; +using IO.Swagger.Api; +using IO.Swagger.Client; +using IO.Swagger.Model; + +namespace Example +{ + public class createOrchestrationTaskExample + { + public void main() + { + + var apiInstance = new OnapsoinfraorchestrationTasksApi(); + var version = version_example; // String | + var body = body_example; // String | (optional) + + try + { + // Create an orchestrationTask + apiInstance.createOrchestrationTask(version, body); + } + catch (Exception e) + { + Debug.Print("Exception when calling OnapsoinfraorchestrationTasksApi.createOrchestrationTask: " + e.Message ); + } + } + } +} +</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-createOrchestrationTask-0-php"> + <pre class="prettyprint"><code class="language-php"><?php +require_once(__DIR__ . '/vendor/autoload.php'); + +$api_instance = new Swagger\Client\Api\OnapsoinfraorchestrationTasksApi(); +$version = version_example; // String | +$body = body_example; // String | + +try { + $api_instance->createOrchestrationTask($version, $body); +} catch (Exception $e) { + echo 'Exception when calling OnapsoinfraorchestrationTasksApi->createOrchestrationTask: ', $e->getMessage(), PHP_EOL; +} +?></code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-createOrchestrationTask-0-perl"> + <pre class="prettyprint"><code class="language-perl">use Data::Dumper; +use WWW::SwaggerClient::Configuration; +use WWW::SwaggerClient::OnapsoinfraorchestrationTasksApi; + +my $api_instance = WWW::SwaggerClient::OnapsoinfraorchestrationTasksApi->new(); +my $version = version_example; # String | +my $body = WWW::SwaggerClient::Object::String->new(); # String | + +eval { + $api_instance->createOrchestrationTask(version => $version, body => $body); +}; +if ($@) { + warn "Exception when calling OnapsoinfraorchestrationTasksApi->createOrchestrationTask: $@\n"; +}</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-createOrchestrationTask-0-python"> + <pre class="prettyprint"><code class="language-python">from __future__ import print_statement +import time +import swagger_client +from swagger_client.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = swagger_client.OnapsoinfraorchestrationTasksApi() +version = version_example # String | +body = body_example # String | (optional) + +try: + # Create an orchestrationTask + api_instance.create_orchestration_task(version, body=body) +except ApiException as e: + print("Exception when calling OnapsoinfraorchestrationTasksApi->createOrchestrationTask: %s\n" % e)</code></pre> + </div> + </div> + + <h2>Parameters</h2> + + <div class="methodsubtabletitle">Path parameters</div> + <table id="methodsubtable"> + <tr> + <th width="150px">Name</th> + <th>Description</th> + </tr> + <tr><td style="width:150px;">version*</td> +<td> + + + <div id="d2e199_createOrchestrationTask_version"> + <div class="json-schema-view"> + <div class="primitive"> + <span class="type"> + String + </span> + + </div> + <div class="inner required"> + Required + </div> + </div> + </div> +</td> +</tr> + + </table> + + + <div class="methodsubtabletitle">Body parameters</div> + <table id="methodsubtable"> + <tr> + <th width="150px">Name</th> + <th>Description</th> + </tr> + <tr><td style="width:150px;">body </td> +<td> + + +<script> +$(document).ready(function() { + var schemaWrapper = { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "type" : "string" + } +}; + var schema = schemaWrapper.schema; + if (schema.$ref != null) { + schema = defsParser.$refs.get(schema.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema,2,{isBodyParam: true}); + var result = $('#d2e199_createOrchestrationTask_body'); + result.empty(); + result.append(view.render()); +}); +</script> +<div id="d2e199_createOrchestrationTask_body"></div> +</td> +</tr> + + </table> + + + + <h2>Responses</h2> + <h3> Status: default - successful operation </h3> + + <ul class="nav nav-tabs nav-tabs-examples" > + </ul> + + <div class="tab-content" style='margin-bottom: 10px;'> + </div> + + </article> + </div> + <hr> + <div id="api-OnapsoinfraorchestrationTasks-deleteOrchestrationTask"> + <article id="api-OnapsoinfraorchestrationTasks-deleteOrchestrationTask-0" data-group="User" data-name="deleteOrchestrationTask" data-version="0"> + <div class="pull-left"> + <h1>deleteOrchestrationTask</h1> + <p>delete orchestrationTask for a given taskId</p> + </div> + <div class="pull-right"></div> + <div class="clearfix"></div> + <p></p> + <p class="marked"></p> + <p></p> + <br /> + <pre class="prettyprint language-html prettyprinted" data-type="delete"><code><span class="pln">/onap/so/infra/orchestrationTasks/{version}/{taskId}</span></code></pre> + <p> + <h3>Usage and SDK Samples</h3> + </p> + <ul class="nav nav-tabs nav-tabs-examples"> + <li class="active"><a href="#examples-OnapsoinfraorchestrationTasks-deleteOrchestrationTask-0-curl">Curl</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-deleteOrchestrationTask-0-java">Java</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-deleteOrchestrationTask-0-android">Android</a></li> + <!--<li class=""><a href="#examples-OnapsoinfraorchestrationTasks-deleteOrchestrationTask-0-groovy">Groovy</a></li>--> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-deleteOrchestrationTask-0-objc">Obj-C</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-deleteOrchestrationTask-0-javascript">JavaScript</a></li> + <!--<li class=""><a href="#examples-OnapsoinfraorchestrationTasks-deleteOrchestrationTask-0-angular">Angular</a></li>--> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-deleteOrchestrationTask-0-csharp">C#</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-deleteOrchestrationTask-0-php">PHP</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-deleteOrchestrationTask-0-perl">Perl</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-deleteOrchestrationTask-0-python">Python</a></li> + </ul> + + <div class="tab-content"> + <div class="tab-pane active" id="examples-OnapsoinfraorchestrationTasks-deleteOrchestrationTask-0-curl"> + <pre class="prettyprint"><code class="language-bsh">curl -X DELETE "http://localhost/onap/so/infra/orchestrationTasks/{version}/{taskId}"</code></pre> + </div> + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-deleteOrchestrationTask-0-java"> + <pre class="prettyprint"><code class="language-java">import io.swagger.client.*; +import io.swagger.client.auth.*; +import io.swagger.client.model.*; +import io.swagger.client.api.OnapsoinfraorchestrationTasksApi; + +import java.io.File; +import java.util.*; + +public class OnapsoinfraorchestrationTasksApiExample { + + public static void main(String[] args) { + + OnapsoinfraorchestrationTasksApi apiInstance = new OnapsoinfraorchestrationTasksApi(); + String taskId = taskId_example; // String | + String version = version_example; // String | + try { + apiInstance.deleteOrchestrationTask(taskId, version); + } catch (ApiException e) { + System.err.println("Exception when calling OnapsoinfraorchestrationTasksApi#deleteOrchestrationTask"); + e.printStackTrace(); + } + } +}</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-deleteOrchestrationTask-0-android"> + <pre class="prettyprint"><code class="language-java">import io.swagger.client.api.OnapsoinfraorchestrationTasksApi; + +public class OnapsoinfraorchestrationTasksApiExample { + + public static void main(String[] args) { + OnapsoinfraorchestrationTasksApi apiInstance = new OnapsoinfraorchestrationTasksApi(); + String taskId = taskId_example; // String | + String version = version_example; // String | + try { + apiInstance.deleteOrchestrationTask(taskId, version); + } catch (ApiException e) { + System.err.println("Exception when calling OnapsoinfraorchestrationTasksApi#deleteOrchestrationTask"); + e.printStackTrace(); + } + } +}</code></pre> + </div> + <!-- + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-deleteOrchestrationTask-0-groovy"> + <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre> + </div> --> + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-deleteOrchestrationTask-0-objc"> + <pre class="prettyprint"><code class="language-cpp">String *taskId = taskId_example; // +String *version = version_example; // + +OnapsoinfraorchestrationTasksApi *apiInstance = [[OnapsoinfraorchestrationTasksApi alloc] init]; + +// delete orchestrationTask for a given taskId +[apiInstance deleteOrchestrationTaskWith:taskId + version:version + completionHandler: ^(NSError* error) { + if (error) { + NSLog(@"Error: %@", error); + } + }]; +</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-deleteOrchestrationTask-0-javascript"> + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); + +var api = new SoGuilinApIs.OnapsoinfraorchestrationTasksApi() + +var taskId = taskId_example; // {String} + +var version = version_example; // {String} + + +var callback = function(error, data, response) { + if (error) { + console.error(error); + } else { + console.log('API called successfully.'); + } +}; +api.deleteOrchestrationTask(taskId, version, callback); +</code></pre> + </div> + + <!--<div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-deleteOrchestrationTask-0-angular"> + <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre> + </div>--> + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-deleteOrchestrationTask-0-csharp"> + <pre class="prettyprint"><code class="language-cs">using System; +using System.Diagnostics; +using IO.Swagger.Api; +using IO.Swagger.Client; +using IO.Swagger.Model; + +namespace Example +{ + public class deleteOrchestrationTaskExample + { + public void main() + { + + var apiInstance = new OnapsoinfraorchestrationTasksApi(); + var taskId = taskId_example; // String | + var version = version_example; // String | + + try + { + // delete orchestrationTask for a given taskId + apiInstance.deleteOrchestrationTask(taskId, version); + } + catch (Exception e) + { + Debug.Print("Exception when calling OnapsoinfraorchestrationTasksApi.deleteOrchestrationTask: " + e.Message ); + } + } + } +} +</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-deleteOrchestrationTask-0-php"> + <pre class="prettyprint"><code class="language-php"><?php +require_once(__DIR__ . '/vendor/autoload.php'); + +$api_instance = new Swagger\Client\Api\OnapsoinfraorchestrationTasksApi(); +$taskId = taskId_example; // String | +$version = version_example; // String | + +try { + $api_instance->deleteOrchestrationTask($taskId, $version); +} catch (Exception $e) { + echo 'Exception when calling OnapsoinfraorchestrationTasksApi->deleteOrchestrationTask: ', $e->getMessage(), PHP_EOL; +} +?></code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-deleteOrchestrationTask-0-perl"> + <pre class="prettyprint"><code class="language-perl">use Data::Dumper; +use WWW::SwaggerClient::Configuration; +use WWW::SwaggerClient::OnapsoinfraorchestrationTasksApi; + +my $api_instance = WWW::SwaggerClient::OnapsoinfraorchestrationTasksApi->new(); +my $taskId = taskId_example; # String | +my $version = version_example; # String | + +eval { + $api_instance->deleteOrchestrationTask(taskId => $taskId, version => $version); +}; +if ($@) { + warn "Exception when calling OnapsoinfraorchestrationTasksApi->deleteOrchestrationTask: $@\n"; +}</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-deleteOrchestrationTask-0-python"> + <pre class="prettyprint"><code class="language-python">from __future__ import print_statement +import time +import swagger_client +from swagger_client.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = swagger_client.OnapsoinfraorchestrationTasksApi() +taskId = taskId_example # String | +version = version_example # String | + +try: + # delete orchestrationTask for a given taskId + api_instance.delete_orchestration_task(taskId, version) +except ApiException as e: + print("Exception when calling OnapsoinfraorchestrationTasksApi->deleteOrchestrationTask: %s\n" % e)</code></pre> + </div> + </div> + + <h2>Parameters</h2> + + <div class="methodsubtabletitle">Path parameters</div> + <table id="methodsubtable"> + <tr> + <th width="150px">Name</th> + <th>Description</th> + </tr> + <tr><td style="width:150px;">taskId*</td> +<td> + + + <div id="d2e199_deleteOrchestrationTask_taskId"> + <div class="json-schema-view"> + <div class="primitive"> + <span class="type"> + String + </span> + + </div> + <div class="inner required"> + Required + </div> + </div> + </div> +</td> +</tr> + + <tr><td style="width:150px;">version*</td> +<td> + + + <div id="d2e199_deleteOrchestrationTask_version"> + <div class="json-schema-view"> + <div class="primitive"> + <span class="type"> + String + </span> + + </div> + <div class="inner required"> + Required + </div> + </div> + </div> +</td> +</tr> + + </table> + + + + + + <h2>Responses</h2> + <h3> Status: default - successful operation </h3> + + <ul class="nav nav-tabs nav-tabs-examples" > + </ul> + + <div class="tab-content" style='margin-bottom: 10px;'> + </div> + + </article> + </div> + <hr> + <div id="api-OnapsoinfraorchestrationTasks-getAllOrchestrationTasks"> + <article id="api-OnapsoinfraorchestrationTasks-getAllOrchestrationTasks-0" data-group="User" data-name="getAllOrchestrationTasks" data-version="0"> + <div class="pull-left"> + <h1>getAllOrchestrationTasks</h1> + <p>Get all orchestrationTasks</p> + </div> + <div class="pull-right"></div> + <div class="clearfix"></div> + <p></p> + <p class="marked"></p> + <p></p> + <br /> + <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/onap/so/infra/orchestrationTasks/{version}</span></code></pre> + <p> + <h3>Usage and SDK Samples</h3> + </p> + <ul class="nav nav-tabs nav-tabs-examples"> + <li class="active"><a href="#examples-OnapsoinfraorchestrationTasks-getAllOrchestrationTasks-0-curl">Curl</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-getAllOrchestrationTasks-0-java">Java</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-getAllOrchestrationTasks-0-android">Android</a></li> + <!--<li class=""><a href="#examples-OnapsoinfraorchestrationTasks-getAllOrchestrationTasks-0-groovy">Groovy</a></li>--> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-getAllOrchestrationTasks-0-objc">Obj-C</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-getAllOrchestrationTasks-0-javascript">JavaScript</a></li> + <!--<li class=""><a href="#examples-OnapsoinfraorchestrationTasks-getAllOrchestrationTasks-0-angular">Angular</a></li>--> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-getAllOrchestrationTasks-0-csharp">C#</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-getAllOrchestrationTasks-0-php">PHP</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-getAllOrchestrationTasks-0-perl">Perl</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-getAllOrchestrationTasks-0-python">Python</a></li> + </ul> + + <div class="tab-content"> + <div class="tab-pane active" id="examples-OnapsoinfraorchestrationTasks-getAllOrchestrationTasks-0-curl"> + <pre class="prettyprint"><code class="language-bsh">curl -X GET "http://localhost/onap/so/infra/orchestrationTasks/{version}"</code></pre> + </div> + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-getAllOrchestrationTasks-0-java"> + <pre class="prettyprint"><code class="language-java">import io.swagger.client.*; +import io.swagger.client.auth.*; +import io.swagger.client.model.*; +import io.swagger.client.api.OnapsoinfraorchestrationTasksApi; + +import java.io.File; +import java.util.*; + +public class OnapsoinfraorchestrationTasksApiExample { + + public static void main(String[] args) { + + OnapsoinfraorchestrationTasksApi apiInstance = new OnapsoinfraorchestrationTasksApi(); + String version = version_example; // String | + try { + apiInstance.getAllOrchestrationTasks(version); + } catch (ApiException e) { + System.err.println("Exception when calling OnapsoinfraorchestrationTasksApi#getAllOrchestrationTasks"); + e.printStackTrace(); + } + } +}</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-getAllOrchestrationTasks-0-android"> + <pre class="prettyprint"><code class="language-java">import io.swagger.client.api.OnapsoinfraorchestrationTasksApi; + +public class OnapsoinfraorchestrationTasksApiExample { + + public static void main(String[] args) { + OnapsoinfraorchestrationTasksApi apiInstance = new OnapsoinfraorchestrationTasksApi(); + String version = version_example; // String | + try { + apiInstance.getAllOrchestrationTasks(version); + } catch (ApiException e) { + System.err.println("Exception when calling OnapsoinfraorchestrationTasksApi#getAllOrchestrationTasks"); + e.printStackTrace(); + } + } +}</code></pre> + </div> + <!-- + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-getAllOrchestrationTasks-0-groovy"> + <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre> + </div> --> + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-getAllOrchestrationTasks-0-objc"> + <pre class="prettyprint"><code class="language-cpp">String *version = version_example; // + +OnapsoinfraorchestrationTasksApi *apiInstance = [[OnapsoinfraorchestrationTasksApi alloc] init]; + +// Get all orchestrationTasks +[apiInstance getAllOrchestrationTasksWith:version + completionHandler: ^(NSError* error) { + if (error) { + NSLog(@"Error: %@", error); + } + }]; +</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-getAllOrchestrationTasks-0-javascript"> + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); + +var api = new SoGuilinApIs.OnapsoinfraorchestrationTasksApi() + +var version = version_example; // {String} + + +var callback = function(error, data, response) { + if (error) { + console.error(error); + } else { + console.log('API called successfully.'); + } +}; +api.getAllOrchestrationTasks(version, callback); +</code></pre> + </div> + + <!--<div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-getAllOrchestrationTasks-0-angular"> + <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre> + </div>--> + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-getAllOrchestrationTasks-0-csharp"> + <pre class="prettyprint"><code class="language-cs">using System; +using System.Diagnostics; +using IO.Swagger.Api; +using IO.Swagger.Client; +using IO.Swagger.Model; + +namespace Example +{ + public class getAllOrchestrationTasksExample + { + public void main() + { + + var apiInstance = new OnapsoinfraorchestrationTasksApi(); + var version = version_example; // String | + + try + { + // Get all orchestrationTasks + apiInstance.getAllOrchestrationTasks(version); + } + catch (Exception e) + { + Debug.Print("Exception when calling OnapsoinfraorchestrationTasksApi.getAllOrchestrationTasks: " + e.Message ); + } + } + } +} +</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-getAllOrchestrationTasks-0-php"> + <pre class="prettyprint"><code class="language-php"><?php +require_once(__DIR__ . '/vendor/autoload.php'); + +$api_instance = new Swagger\Client\Api\OnapsoinfraorchestrationTasksApi(); +$version = version_example; // String | + +try { + $api_instance->getAllOrchestrationTasks($version); +} catch (Exception $e) { + echo 'Exception when calling OnapsoinfraorchestrationTasksApi->getAllOrchestrationTasks: ', $e->getMessage(), PHP_EOL; +} +?></code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-getAllOrchestrationTasks-0-perl"> + <pre class="prettyprint"><code class="language-perl">use Data::Dumper; +use WWW::SwaggerClient::Configuration; +use WWW::SwaggerClient::OnapsoinfraorchestrationTasksApi; + +my $api_instance = WWW::SwaggerClient::OnapsoinfraorchestrationTasksApi->new(); +my $version = version_example; # String | + +eval { + $api_instance->getAllOrchestrationTasks(version => $version); +}; +if ($@) { + warn "Exception when calling OnapsoinfraorchestrationTasksApi->getAllOrchestrationTasks: $@\n"; +}</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-getAllOrchestrationTasks-0-python"> + <pre class="prettyprint"><code class="language-python">from __future__ import print_statement +import time +import swagger_client +from swagger_client.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = swagger_client.OnapsoinfraorchestrationTasksApi() +version = version_example # String | + +try: + # Get all orchestrationTasks + api_instance.get_all_orchestration_tasks(version) +except ApiException as e: + print("Exception when calling OnapsoinfraorchestrationTasksApi->getAllOrchestrationTasks: %s\n" % e)</code></pre> + </div> + </div> + + <h2>Parameters</h2> + + <div class="methodsubtabletitle">Path parameters</div> + <table id="methodsubtable"> + <tr> + <th width="150px">Name</th> + <th>Description</th> + </tr> + <tr><td style="width:150px;">version*</td> +<td> + + + <div id="d2e199_getAllOrchestrationTasks_version"> + <div class="json-schema-view"> + <div class="primitive"> + <span class="type"> + String + </span> + + </div> + <div class="inner required"> + Required + </div> + </div> + </div> +</td> +</tr> + + </table> + + + + + + <h2>Responses</h2> + <h3> Status: default - successful operation </h3> + + <ul class="nav nav-tabs nav-tabs-examples" > + </ul> + + <div class="tab-content" style='margin-bottom: 10px;'> + </div> + + </article> + </div> + <hr> + <div id="api-OnapsoinfraorchestrationTasks-getOrchestrationTask"> + <article id="api-OnapsoinfraorchestrationTasks-getOrchestrationTask-0" data-group="User" data-name="getOrchestrationTask" data-version="0"> + <div class="pull-left"> + <h1>getOrchestrationTask</h1> + <p>Get orchestrationTask for a given taskId</p> + </div> + <div class="pull-right"></div> + <div class="clearfix"></div> + <p></p> + <p class="marked"></p> + <p></p> + <br /> + <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/onap/so/infra/orchestrationTasks/{version}/{taskId}</span></code></pre> + <p> + <h3>Usage and SDK Samples</h3> + </p> + <ul class="nav nav-tabs nav-tabs-examples"> + <li class="active"><a href="#examples-OnapsoinfraorchestrationTasks-getOrchestrationTask-0-curl">Curl</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-getOrchestrationTask-0-java">Java</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-getOrchestrationTask-0-android">Android</a></li> + <!--<li class=""><a href="#examples-OnapsoinfraorchestrationTasks-getOrchestrationTask-0-groovy">Groovy</a></li>--> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-getOrchestrationTask-0-objc">Obj-C</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-getOrchestrationTask-0-javascript">JavaScript</a></li> + <!--<li class=""><a href="#examples-OnapsoinfraorchestrationTasks-getOrchestrationTask-0-angular">Angular</a></li>--> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-getOrchestrationTask-0-csharp">C#</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-getOrchestrationTask-0-php">PHP</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-getOrchestrationTask-0-perl">Perl</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-getOrchestrationTask-0-python">Python</a></li> + </ul> + + <div class="tab-content"> + <div class="tab-pane active" id="examples-OnapsoinfraorchestrationTasks-getOrchestrationTask-0-curl"> + <pre class="prettyprint"><code class="language-bsh">curl -X GET "http://localhost/onap/so/infra/orchestrationTasks/{version}/{taskId}"</code></pre> + </div> + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-getOrchestrationTask-0-java"> + <pre class="prettyprint"><code class="language-java">import io.swagger.client.*; +import io.swagger.client.auth.*; +import io.swagger.client.model.*; +import io.swagger.client.api.OnapsoinfraorchestrationTasksApi; + +import java.io.File; +import java.util.*; + +public class OnapsoinfraorchestrationTasksApiExample { + + public static void main(String[] args) { + + OnapsoinfraorchestrationTasksApi apiInstance = new OnapsoinfraorchestrationTasksApi(); + String taskId = taskId_example; // String | + String version = version_example; // String | + try { + apiInstance.getOrchestrationTask(taskId, version); + } catch (ApiException e) { + System.err.println("Exception when calling OnapsoinfraorchestrationTasksApi#getOrchestrationTask"); + e.printStackTrace(); + } + } +}</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-getOrchestrationTask-0-android"> + <pre class="prettyprint"><code class="language-java">import io.swagger.client.api.OnapsoinfraorchestrationTasksApi; + +public class OnapsoinfraorchestrationTasksApiExample { + + public static void main(String[] args) { + OnapsoinfraorchestrationTasksApi apiInstance = new OnapsoinfraorchestrationTasksApi(); + String taskId = taskId_example; // String | + String version = version_example; // String | + try { + apiInstance.getOrchestrationTask(taskId, version); + } catch (ApiException e) { + System.err.println("Exception when calling OnapsoinfraorchestrationTasksApi#getOrchestrationTask"); + e.printStackTrace(); + } + } +}</code></pre> + </div> + <!-- + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-getOrchestrationTask-0-groovy"> + <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre> + </div> --> + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-getOrchestrationTask-0-objc"> + <pre class="prettyprint"><code class="language-cpp">String *taskId = taskId_example; // +String *version = version_example; // + +OnapsoinfraorchestrationTasksApi *apiInstance = [[OnapsoinfraorchestrationTasksApi alloc] init]; + +// Get orchestrationTask for a given taskId +[apiInstance getOrchestrationTaskWith:taskId + version:version + completionHandler: ^(NSError* error) { + if (error) { + NSLog(@"Error: %@", error); + } + }]; +</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-getOrchestrationTask-0-javascript"> + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); + +var api = new SoGuilinApIs.OnapsoinfraorchestrationTasksApi() + +var taskId = taskId_example; // {String} + +var version = version_example; // {String} + + +var callback = function(error, data, response) { + if (error) { + console.error(error); + } else { + console.log('API called successfully.'); + } +}; +api.getOrchestrationTask(taskId, version, callback); +</code></pre> + </div> + + <!--<div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-getOrchestrationTask-0-angular"> + <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre> + </div>--> + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-getOrchestrationTask-0-csharp"> + <pre class="prettyprint"><code class="language-cs">using System; +using System.Diagnostics; +using IO.Swagger.Api; +using IO.Swagger.Client; +using IO.Swagger.Model; + +namespace Example +{ + public class getOrchestrationTaskExample + { + public void main() + { + + var apiInstance = new OnapsoinfraorchestrationTasksApi(); + var taskId = taskId_example; // String | + var version = version_example; // String | + + try + { + // Get orchestrationTask for a given taskId + apiInstance.getOrchestrationTask(taskId, version); + } + catch (Exception e) + { + Debug.Print("Exception when calling OnapsoinfraorchestrationTasksApi.getOrchestrationTask: " + e.Message ); + } + } + } +} +</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-getOrchestrationTask-0-php"> + <pre class="prettyprint"><code class="language-php"><?php +require_once(__DIR__ . '/vendor/autoload.php'); + +$api_instance = new Swagger\Client\Api\OnapsoinfraorchestrationTasksApi(); +$taskId = taskId_example; // String | +$version = version_example; // String | + +try { + $api_instance->getOrchestrationTask($taskId, $version); +} catch (Exception $e) { + echo 'Exception when calling OnapsoinfraorchestrationTasksApi->getOrchestrationTask: ', $e->getMessage(), PHP_EOL; +} +?></code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-getOrchestrationTask-0-perl"> + <pre class="prettyprint"><code class="language-perl">use Data::Dumper; +use WWW::SwaggerClient::Configuration; +use WWW::SwaggerClient::OnapsoinfraorchestrationTasksApi; + +my $api_instance = WWW::SwaggerClient::OnapsoinfraorchestrationTasksApi->new(); +my $taskId = taskId_example; # String | +my $version = version_example; # String | + +eval { + $api_instance->getOrchestrationTask(taskId => $taskId, version => $version); +}; +if ($@) { + warn "Exception when calling OnapsoinfraorchestrationTasksApi->getOrchestrationTask: $@\n"; +}</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-getOrchestrationTask-0-python"> + <pre class="prettyprint"><code class="language-python">from __future__ import print_statement +import time +import swagger_client +from swagger_client.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = swagger_client.OnapsoinfraorchestrationTasksApi() +taskId = taskId_example # String | +version = version_example # String | + +try: + # Get orchestrationTask for a given taskId + api_instance.get_orchestration_task(taskId, version) +except ApiException as e: + print("Exception when calling OnapsoinfraorchestrationTasksApi->getOrchestrationTask: %s\n" % e)</code></pre> + </div> + </div> + + <h2>Parameters</h2> + + <div class="methodsubtabletitle">Path parameters</div> + <table id="methodsubtable"> + <tr> + <th width="150px">Name</th> + <th>Description</th> + </tr> + <tr><td style="width:150px;">taskId*</td> +<td> + + + <div id="d2e199_getOrchestrationTask_taskId"> + <div class="json-schema-view"> + <div class="primitive"> + <span class="type"> + String + </span> + + </div> + <div class="inner required"> + Required + </div> + </div> + </div> +</td> +</tr> + + <tr><td style="width:150px;">version*</td> +<td> + + + <div id="d2e199_getOrchestrationTask_version"> + <div class="json-schema-view"> + <div class="primitive"> + <span class="type"> + String + </span> + + </div> + <div class="inner required"> + Required + </div> + </div> + </div> +</td> +</tr> + + </table> + + + + + + <h2>Responses</h2> + <h3> Status: default - successful operation </h3> + + <ul class="nav nav-tabs nav-tabs-examples" > + </ul> + + <div class="tab-content" style='margin-bottom: 10px;'> + </div> + + </article> + </div> + <hr> + <div id="api-OnapsoinfraorchestrationTasks-updateOrchestrationTask"> + <article id="api-OnapsoinfraorchestrationTasks-updateOrchestrationTask-0" data-group="User" data-name="updateOrchestrationTask" data-version="0"> + <div class="pull-left"> + <h1>updateOrchestrationTask</h1> + <p>update orchestrationTask for a given taskId</p> + </div> + <div class="pull-right"></div> + <div class="clearfix"></div> + <p></p> + <p class="marked"></p> + <p></p> + <br /> + <pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/onap/so/infra/orchestrationTasks/{version}/{taskId}</span></code></pre> + <p> + <h3>Usage and SDK Samples</h3> + </p> + <ul class="nav nav-tabs nav-tabs-examples"> + <li class="active"><a href="#examples-OnapsoinfraorchestrationTasks-updateOrchestrationTask-0-curl">Curl</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-updateOrchestrationTask-0-java">Java</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-updateOrchestrationTask-0-android">Android</a></li> + <!--<li class=""><a href="#examples-OnapsoinfraorchestrationTasks-updateOrchestrationTask-0-groovy">Groovy</a></li>--> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-updateOrchestrationTask-0-objc">Obj-C</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-updateOrchestrationTask-0-javascript">JavaScript</a></li> + <!--<li class=""><a href="#examples-OnapsoinfraorchestrationTasks-updateOrchestrationTask-0-angular">Angular</a></li>--> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-updateOrchestrationTask-0-csharp">C#</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-updateOrchestrationTask-0-php">PHP</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-updateOrchestrationTask-0-perl">Perl</a></li> + <li class=""><a href="#examples-OnapsoinfraorchestrationTasks-updateOrchestrationTask-0-python">Python</a></li> + </ul> + + <div class="tab-content"> + <div class="tab-pane active" id="examples-OnapsoinfraorchestrationTasks-updateOrchestrationTask-0-curl"> + <pre class="prettyprint"><code class="language-bsh">curl -X PUT "http://localhost/onap/so/infra/orchestrationTasks/{version}/{taskId}"</code></pre> + </div> + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-updateOrchestrationTask-0-java"> + <pre class="prettyprint"><code class="language-java">import io.swagger.client.*; +import io.swagger.client.auth.*; +import io.swagger.client.model.*; +import io.swagger.client.api.OnapsoinfraorchestrationTasksApi; + +import java.io.File; +import java.util.*; + +public class OnapsoinfraorchestrationTasksApiExample { + + public static void main(String[] args) { + + OnapsoinfraorchestrationTasksApi apiInstance = new OnapsoinfraorchestrationTasksApi(); + String taskId = taskId_example; // String | + String version = version_example; // String | + String body = body_example; // String | + try { + apiInstance.updateOrchestrationTask(taskId, version, body); + } catch (ApiException e) { + System.err.println("Exception when calling OnapsoinfraorchestrationTasksApi#updateOrchestrationTask"); + e.printStackTrace(); + } + } +}</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-updateOrchestrationTask-0-android"> + <pre class="prettyprint"><code class="language-java">import io.swagger.client.api.OnapsoinfraorchestrationTasksApi; + +public class OnapsoinfraorchestrationTasksApiExample { + + public static void main(String[] args) { + OnapsoinfraorchestrationTasksApi apiInstance = new OnapsoinfraorchestrationTasksApi(); + String taskId = taskId_example; // String | + String version = version_example; // String | + String body = body_example; // String | + try { + apiInstance.updateOrchestrationTask(taskId, version, body); + } catch (ApiException e) { + System.err.println("Exception when calling OnapsoinfraorchestrationTasksApi#updateOrchestrationTask"); + e.printStackTrace(); + } + } +}</code></pre> + </div> + <!-- + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-updateOrchestrationTask-0-groovy"> + <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre> + </div> --> + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-updateOrchestrationTask-0-objc"> + <pre class="prettyprint"><code class="language-cpp">String *taskId = taskId_example; // +String *version = version_example; // +String *body = body_example; // (optional) + +OnapsoinfraorchestrationTasksApi *apiInstance = [[OnapsoinfraorchestrationTasksApi alloc] init]; + +// update orchestrationTask for a given taskId +[apiInstance updateOrchestrationTaskWith:taskId + version:version + body:body + completionHandler: ^(NSError* error) { + if (error) { + NSLog(@"Error: %@", error); + } + }]; +</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-updateOrchestrationTask-0-javascript"> + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); + +var api = new SoGuilinApIs.OnapsoinfraorchestrationTasksApi() + +var taskId = taskId_example; // {String} + +var version = version_example; // {String} + +var opts = { + 'body': body_example // {String} +}; + +var callback = function(error, data, response) { + if (error) { + console.error(error); + } else { + console.log('API called successfully.'); + } +}; +api.updateOrchestrationTask(taskId, version, opts, callback); +</code></pre> + </div> + + <!--<div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-updateOrchestrationTask-0-angular"> + <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre> + </div>--> + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-updateOrchestrationTask-0-csharp"> + <pre class="prettyprint"><code class="language-cs">using System; +using System.Diagnostics; +using IO.Swagger.Api; +using IO.Swagger.Client; +using IO.Swagger.Model; + +namespace Example +{ + public class updateOrchestrationTaskExample + { + public void main() + { + + var apiInstance = new OnapsoinfraorchestrationTasksApi(); + var taskId = taskId_example; // String | + var version = version_example; // String | + var body = body_example; // String | (optional) + + try + { + // update orchestrationTask for a given taskId + apiInstance.updateOrchestrationTask(taskId, version, body); + } + catch (Exception e) + { + Debug.Print("Exception when calling OnapsoinfraorchestrationTasksApi.updateOrchestrationTask: " + e.Message ); + } + } + } +} +</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-updateOrchestrationTask-0-php"> + <pre class="prettyprint"><code class="language-php"><?php +require_once(__DIR__ . '/vendor/autoload.php'); + +$api_instance = new Swagger\Client\Api\OnapsoinfraorchestrationTasksApi(); +$taskId = taskId_example; // String | +$version = version_example; // String | +$body = body_example; // String | + +try { + $api_instance->updateOrchestrationTask($taskId, $version, $body); +} catch (Exception $e) { + echo 'Exception when calling OnapsoinfraorchestrationTasksApi->updateOrchestrationTask: ', $e->getMessage(), PHP_EOL; +} +?></code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-updateOrchestrationTask-0-perl"> + <pre class="prettyprint"><code class="language-perl">use Data::Dumper; +use WWW::SwaggerClient::Configuration; +use WWW::SwaggerClient::OnapsoinfraorchestrationTasksApi; + +my $api_instance = WWW::SwaggerClient::OnapsoinfraorchestrationTasksApi->new(); +my $taskId = taskId_example; # String | +my $version = version_example; # String | +my $body = WWW::SwaggerClient::Object::String->new(); # String | + +eval { + $api_instance->updateOrchestrationTask(taskId => $taskId, version => $version, body => $body); +}; +if ($@) { + warn "Exception when calling OnapsoinfraorchestrationTasksApi->updateOrchestrationTask: $@\n"; +}</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraorchestrationTasks-updateOrchestrationTask-0-python"> + <pre class="prettyprint"><code class="language-python">from __future__ import print_statement +import time +import swagger_client +from swagger_client.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = swagger_client.OnapsoinfraorchestrationTasksApi() +taskId = taskId_example # String | +version = version_example # String | +body = body_example # String | (optional) + +try: + # update orchestrationTask for a given taskId + api_instance.update_orchestration_task(taskId, version, body=body) +except ApiException as e: + print("Exception when calling OnapsoinfraorchestrationTasksApi->updateOrchestrationTask: %s\n" % e)</code></pre> + </div> + </div> + + <h2>Parameters</h2> + + <div class="methodsubtabletitle">Path parameters</div> + <table id="methodsubtable"> + <tr> + <th width="150px">Name</th> + <th>Description</th> + </tr> + <tr><td style="width:150px;">taskId*</td> +<td> + + + <div id="d2e199_updateOrchestrationTask_taskId"> + <div class="json-schema-view"> + <div class="primitive"> + <span class="type"> + String + </span> + + </div> + <div class="inner required"> + Required + </div> + </div> + </div> +</td> +</tr> + + <tr><td style="width:150px;">version*</td> +<td> + + + <div id="d2e199_updateOrchestrationTask_version"> + <div class="json-schema-view"> + <div class="primitive"> + <span class="type"> + String + </span> + + </div> + <div class="inner required"> + Required + </div> + </div> + </div> +</td> +</tr> + + </table> + + + <div class="methodsubtabletitle">Body parameters</div> + <table id="methodsubtable"> + <tr> + <th width="150px">Name</th> + <th>Description</th> + </tr> + <tr><td style="width:150px;">body </td> +<td> + + +<script> +$(document).ready(function() { + var schemaWrapper = { + "in" : "body", + "name" : "body", + "required" : false, + "schema" : { + "type" : "string" + } +}; + var schema = schemaWrapper.schema; + if (schema.$ref != null) { + schema = defsParser.$refs.get(schema.$ref); + } else { + schemaWrapper.definitions = Object.assign({}, defs); + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + var view = new JSONSchemaView(schema,2,{isBodyParam: true}); + var result = $('#d2e199_updateOrchestrationTask_body'); + result.empty(); + result.append(view.render()); +}); +</script> +<div id="d2e199_updateOrchestrationTask_body"></div> +</td> +</tr> + + </table> + + + + <h2>Responses</h2> + <h3> Status: default - successful operation </h3> + + <ul class="nav nav-tabs nav-tabs-examples" > + </ul> + + <div class="tab-content" style='margin-bottom: 10px;'> + </div> + + </article> + </div> + <hr> + </section> <section id="api-OnapsoinfraserviceInstantiation"> <h1>OnapsoinfraserviceInstantiation</h1> <div id="api-OnapsoinfraserviceInstantiation-activatePort"> @@ -6079,9 +11299,9 @@ OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiat </div> <div class="tab-pane" id="examples-OnapsoinfraserviceInstantiation-activatePort-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi() +var api = new SoGuilinApIs.OnapsoinfraserviceInstantiationApi() var version = version_example; // {String} @@ -6432,9 +11652,9 @@ OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiat </div> <div class="tab-pane" id="examples-OnapsoinfraserviceInstantiation-activateServiceInstance-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi() +var api = new SoGuilinApIs.OnapsoinfraserviceInstantiationApi() var version = version_example; // {String} @@ -6759,9 +11979,9 @@ OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiat </div> <div class="tab-pane" id="examples-OnapsoinfraserviceInstantiation-addRelationships-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi() +var api = new SoGuilinApIs.OnapsoinfraserviceInstantiationApi() var version = version_example; // {String} @@ -7090,9 +12310,9 @@ OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiat </div> <div class="tab-pane" id="examples-OnapsoinfraserviceInstantiation-applyUpdatedConfig-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi() +var api = new SoGuilinApIs.OnapsoinfraserviceInstantiationApi() var version = version_example; // {String} @@ -7439,9 +12659,9 @@ OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiat </div> <div class="tab-pane" id="examples-OnapsoinfraserviceInstantiation-assignServiceInstance-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi() +var api = new SoGuilinApIs.OnapsoinfraserviceInstantiationApi() var version = version_example; // {String} @@ -7740,9 +12960,9 @@ OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiat </div> <div class="tab-pane" id="examples-OnapsoinfraserviceInstantiation-createNetworkInstance-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi() +var api = new SoGuilinApIs.OnapsoinfraserviceInstantiationApi() var version = version_example; // {String} @@ -8067,9 +13287,9 @@ OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiat </div> <div class="tab-pane" id="examples-OnapsoinfraserviceInstantiation-createPortConfiguration-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi() +var api = new SoGuilinApIs.OnapsoinfraserviceInstantiationApi() var version = version_example; // {String} @@ -8390,9 +13610,9 @@ OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiat </div> <div class="tab-pane" id="examples-OnapsoinfraserviceInstantiation-createServiceInstance-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi() +var api = new SoGuilinApIs.OnapsoinfraserviceInstantiationApi() var version = version_example; // {String} @@ -8695,9 +13915,9 @@ OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiat </div> <div class="tab-pane" id="examples-OnapsoinfraserviceInstantiation-createVfModuleInstance-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi() +var api = new SoGuilinApIs.OnapsoinfraserviceInstantiationApi() var version = version_example; // {String} @@ -9048,9 +14268,9 @@ OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiat </div> <div class="tab-pane" id="examples-OnapsoinfraserviceInstantiation-createVnfInstance-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi() +var api = new SoGuilinApIs.OnapsoinfraserviceInstantiationApi() var version = version_example; // {String} @@ -9379,9 +14599,9 @@ OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiat </div> <div class="tab-pane" id="examples-OnapsoinfraserviceInstantiation-createVolumeGroupInstance-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi() +var api = new SoGuilinApIs.OnapsoinfraserviceInstantiationApi() var version = version_example; // {String} @@ -9740,9 +14960,9 @@ OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiat </div> <div class="tab-pane" id="examples-OnapsoinfraserviceInstantiation-deactivateAndCloudDeleteVfModuleInstance-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi() +var api = new SoGuilinApIs.OnapsoinfraserviceInstantiationApi() var version = version_example; // {String} @@ -10123,9 +15343,9 @@ OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiat </div> <div class="tab-pane" id="examples-OnapsoinfraserviceInstantiation-deactivatePort-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi() +var api = new SoGuilinApIs.OnapsoinfraserviceInstantiationApi() var version = version_example; // {String} @@ -10476,9 +15696,9 @@ OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiat </div> <div class="tab-pane" id="examples-OnapsoinfraserviceInstantiation-deactivateServiceInstance-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi() +var api = new SoGuilinApIs.OnapsoinfraserviceInstantiationApi() var version = version_example; // {String} @@ -10807,9 +16027,9 @@ OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiat </div> <div class="tab-pane" id="examples-OnapsoinfraserviceInstantiation-deleteNetworkInstance-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi() +var api = new SoGuilinApIs.OnapsoinfraserviceInstantiationApi() var version = version_example; // {String} @@ -11164,9 +16384,9 @@ OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiat </div> <div class="tab-pane" id="examples-OnapsoinfraserviceInstantiation-deletePortConfiguration-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi() +var api = new SoGuilinApIs.OnapsoinfraserviceInstantiationApi() var version = version_example; // {String} @@ -11517,9 +16737,9 @@ OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiat </div> <div class="tab-pane" id="examples-OnapsoinfraserviceInstantiation-deleteServiceInstance-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi() +var api = new SoGuilinApIs.OnapsoinfraserviceInstantiationApi() var version = version_example; // {String} @@ -11852,9 +17072,9 @@ OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiat </div> <div class="tab-pane" id="examples-OnapsoinfraserviceInstantiation-deleteVfModuleInstance-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi() +var api = new SoGuilinApIs.OnapsoinfraserviceInstantiationApi() var version = version_example; // {String} @@ -12235,9 +17455,9 @@ OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiat </div> <div class="tab-pane" id="examples-OnapsoinfraserviceInstantiation-deleteVnfInstance-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi() +var api = new SoGuilinApIs.OnapsoinfraserviceInstantiationApi() var version = version_example; // {String} @@ -12596,9 +17816,9 @@ OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiat </div> <div class="tab-pane" id="examples-OnapsoinfraserviceInstantiation-deleteVolumeGroupInstance-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi() +var api = new SoGuilinApIs.OnapsoinfraserviceInstantiationApi() var version = version_example; // {String} @@ -12979,9 +18199,9 @@ OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiat </div> <div class="tab-pane" id="examples-OnapsoinfraserviceInstantiation-disablePort-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi() +var api = new SoGuilinApIs.OnapsoinfraserviceInstantiationApi() var version = version_example; // {String} @@ -13336,9 +18556,9 @@ OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiat </div> <div class="tab-pane" id="examples-OnapsoinfraserviceInstantiation-enablePort-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi() +var api = new SoGuilinApIs.OnapsoinfraserviceInstantiationApi() var version = version_example; // {String} @@ -13693,9 +18913,9 @@ OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiat </div> <div class="tab-pane" id="examples-OnapsoinfraserviceInstantiation-inPlaceSoftwareUpdate-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi() +var api = new SoGuilinApIs.OnapsoinfraserviceInstantiationApi() var version = version_example; // {String} @@ -14046,9 +19266,9 @@ OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiat </div> <div class="tab-pane" id="examples-OnapsoinfraserviceInstantiation-removeRelationships-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi() +var api = new SoGuilinApIs.OnapsoinfraserviceInstantiationApi() var version = version_example; // {String} @@ -14381,9 +19601,9 @@ OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiat </div> <div class="tab-pane" id="examples-OnapsoinfraserviceInstantiation-replaceVfModuleInstance-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi() +var api = new SoGuilinApIs.OnapsoinfraserviceInstantiationApi() var version = version_example; // {String} @@ -14764,9 +19984,9 @@ OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiat </div> <div class="tab-pane" id="examples-OnapsoinfraserviceInstantiation-replaceVnfInstance-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi() +var api = new SoGuilinApIs.OnapsoinfraserviceInstantiationApi() var version = version_example; // {String} @@ -15121,9 +20341,9 @@ OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiat </div> <div class="tab-pane" id="examples-OnapsoinfraserviceInstantiation-scaleOutVfModule-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi() +var api = new SoGuilinApIs.OnapsoinfraserviceInstantiationApi() var version = version_example; // {String} @@ -15474,9 +20694,9 @@ OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiat </div> <div class="tab-pane" id="examples-OnapsoinfraserviceInstantiation-unassignServiceInstance-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi() +var api = new SoGuilinApIs.OnapsoinfraserviceInstantiationApi() var version = version_example; // {String} @@ -15805,9 +21025,9 @@ OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiat </div> <div class="tab-pane" id="examples-OnapsoinfraserviceInstantiation-updateNetworkInstance-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi() +var api = new SoGuilinApIs.OnapsoinfraserviceInstantiationApi() var version = version_example; // {String} @@ -16166,9 +21386,9 @@ OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiat </div> <div class="tab-pane" id="examples-OnapsoinfraserviceInstantiation-updateVfModuleInstance-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi() +var api = new SoGuilinApIs.OnapsoinfraserviceInstantiationApi() var version = version_example; // {String} @@ -16549,9 +21769,9 @@ OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiat </div> <div class="tab-pane" id="examples-OnapsoinfraserviceInstantiation-updateVnfInstance-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi() +var api = new SoGuilinApIs.OnapsoinfraserviceInstantiationApi() var version = version_example; // {String} @@ -16910,9 +22130,9 @@ OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiat </div> <div class="tab-pane" id="examples-OnapsoinfraserviceInstantiation-updateVolumeGroupInstance-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi() +var api = new SoGuilinApIs.OnapsoinfraserviceInstantiationApi() var version = version_example; // {String} @@ -17312,9 +22532,9 @@ OnapsoinfratasksApi *apiInstance = [[OnapsoinfratasksApi alloc] init]; </div> <div class="tab-pane" id="examples-Onapsoinfratasks-queryFilters-0-javascript"> - <pre class="prettyprint"><code class="language-js">var SoCasablancaApIs = require('so_casablanca_ap_is'); + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); -var api = new SoCasablancaApIs.OnapsoinfratasksApi() +var api = new SoGuilinApIs.OnapsoinfratasksApi() var version = version_example; // {String} @@ -17625,6 +22845,333 @@ except ApiException as e: </div> <hr> </section> + <section id="api-OnapsoinfraworkflowSpecifications"> + <h1>OnapsoinfraworkflowSpecifications</h1> + <div id="api-OnapsoinfraworkflowSpecifications-queryWorkflowSpecifications"> + <article id="api-OnapsoinfraworkflowSpecifications-queryWorkflowSpecifications-0" data-group="User" data-name="queryWorkflowSpecifications" data-version="0"> + <div class="pull-left"> + <h1>queryWorkflowSpecifications</h1> + <p>Retrieve Workflow details based on the filter criteria</p> + </div> + <div class="pull-right"></div> + <div class="clearfix"></div> + <p></p> + <p class="marked"></p> + <p></p> + <br /> + <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/onap/so/infra/workflowSpecifications/{version}/workflows</span></code></pre> + <p> + <h3>Usage and SDK Samples</h3> + </p> + <ul class="nav nav-tabs nav-tabs-examples"> + <li class="active"><a href="#examples-OnapsoinfraworkflowSpecifications-queryWorkflowSpecifications-0-curl">Curl</a></li> + <li class=""><a href="#examples-OnapsoinfraworkflowSpecifications-queryWorkflowSpecifications-0-java">Java</a></li> + <li class=""><a href="#examples-OnapsoinfraworkflowSpecifications-queryWorkflowSpecifications-0-android">Android</a></li> + <!--<li class=""><a href="#examples-OnapsoinfraworkflowSpecifications-queryWorkflowSpecifications-0-groovy">Groovy</a></li>--> + <li class=""><a href="#examples-OnapsoinfraworkflowSpecifications-queryWorkflowSpecifications-0-objc">Obj-C</a></li> + <li class=""><a href="#examples-OnapsoinfraworkflowSpecifications-queryWorkflowSpecifications-0-javascript">JavaScript</a></li> + <!--<li class=""><a href="#examples-OnapsoinfraworkflowSpecifications-queryWorkflowSpecifications-0-angular">Angular</a></li>--> + <li class=""><a href="#examples-OnapsoinfraworkflowSpecifications-queryWorkflowSpecifications-0-csharp">C#</a></li> + <li class=""><a href="#examples-OnapsoinfraworkflowSpecifications-queryWorkflowSpecifications-0-php">PHP</a></li> + <li class=""><a href="#examples-OnapsoinfraworkflowSpecifications-queryWorkflowSpecifications-0-perl">Perl</a></li> + <li class=""><a href="#examples-OnapsoinfraworkflowSpecifications-queryWorkflowSpecifications-0-python">Python</a></li> + </ul> + + <div class="tab-content"> + <div class="tab-pane active" id="examples-OnapsoinfraworkflowSpecifications-queryWorkflowSpecifications-0-curl"> + <pre class="prettyprint"><code class="language-bsh">curl -X GET "http://localhost/onap/so/infra/workflowSpecifications/{version}/workflows?resourceTarget="</code></pre> + </div> + <div class="tab-pane" id="examples-OnapsoinfraworkflowSpecifications-queryWorkflowSpecifications-0-java"> + <pre class="prettyprint"><code class="language-java">import io.swagger.client.*; +import io.swagger.client.auth.*; +import io.swagger.client.model.*; +import io.swagger.client.api.OnapsoinfraworkflowSpecificationsApi; + +import java.io.File; +import java.util.*; + +public class OnapsoinfraworkflowSpecificationsApiExample { + + public static void main(String[] args) { + + OnapsoinfraworkflowSpecificationsApi apiInstance = new OnapsoinfraworkflowSpecificationsApi(); + String version = version_example; // String | + String resourceTarget = resourceTarget_example; // String | + try { + RetrievingWorkflowResponse result = apiInstance.queryWorkflowSpecifications(version, resourceTarget); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling OnapsoinfraworkflowSpecificationsApi#queryWorkflowSpecifications"); + e.printStackTrace(); + } + } +}</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraworkflowSpecifications-queryWorkflowSpecifications-0-android"> + <pre class="prettyprint"><code class="language-java">import io.swagger.client.api.OnapsoinfraworkflowSpecificationsApi; + +public class OnapsoinfraworkflowSpecificationsApiExample { + + public static void main(String[] args) { + OnapsoinfraworkflowSpecificationsApi apiInstance = new OnapsoinfraworkflowSpecificationsApi(); + String version = version_example; // String | + String resourceTarget = resourceTarget_example; // String | + try { + RetrievingWorkflowResponse result = apiInstance.queryWorkflowSpecifications(version, resourceTarget); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling OnapsoinfraworkflowSpecificationsApi#queryWorkflowSpecifications"); + e.printStackTrace(); + } + } +}</code></pre> + </div> + <!-- + <div class="tab-pane" id="examples-OnapsoinfraworkflowSpecifications-queryWorkflowSpecifications-0-groovy"> + <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre> + </div> --> + <div class="tab-pane" id="examples-OnapsoinfraworkflowSpecifications-queryWorkflowSpecifications-0-objc"> + <pre class="prettyprint"><code class="language-cpp">String *version = version_example; // +String *resourceTarget = resourceTarget_example; // (optional) + +OnapsoinfraworkflowSpecificationsApi *apiInstance = [[OnapsoinfraworkflowSpecificationsApi alloc] init]; + +// Retrieve Workflow details based on the filter criteria +[apiInstance queryWorkflowSpecificationsWith:version + resourceTarget:resourceTarget + completionHandler: ^(RetrievingWorkflowResponse output, NSError* error) { + if (output) { + NSLog(@"%@", output); + } + if (error) { + NSLog(@"Error: %@", error); + } + }]; +</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraworkflowSpecifications-queryWorkflowSpecifications-0-javascript"> + <pre class="prettyprint"><code class="language-js">var SoGuilinApIs = require('so_guilin_ap_is'); + +var api = new SoGuilinApIs.OnapsoinfraworkflowSpecificationsApi() + +var version = version_example; // {String} + +var opts = { + 'resourceTarget': resourceTarget_example // {String} +}; + +var callback = function(error, data, response) { + if (error) { + console.error(error); + } else { + console.log('API called successfully. Returned data: ' + data); + } +}; +api.queryWorkflowSpecifications(version, opts, callback); +</code></pre> + </div> + + <!--<div class="tab-pane" id="examples-OnapsoinfraworkflowSpecifications-queryWorkflowSpecifications-0-angular"> + <pre class="prettyprint language-json prettyprinted" data-type="json"><code>Coming Soon!</code></pre> + </div>--> + <div class="tab-pane" id="examples-OnapsoinfraworkflowSpecifications-queryWorkflowSpecifications-0-csharp"> + <pre class="prettyprint"><code class="language-cs">using System; +using System.Diagnostics; +using IO.Swagger.Api; +using IO.Swagger.Client; +using IO.Swagger.Model; + +namespace Example +{ + public class queryWorkflowSpecificationsExample + { + public void main() + { + + var apiInstance = new OnapsoinfraworkflowSpecificationsApi(); + var version = version_example; // String | + var resourceTarget = resourceTarget_example; // String | (optional) + + try + { + // Retrieve Workflow details based on the filter criteria + RetrievingWorkflowResponse result = apiInstance.queryWorkflowSpecifications(version, resourceTarget); + Debug.WriteLine(result); + } + catch (Exception e) + { + Debug.Print("Exception when calling OnapsoinfraworkflowSpecificationsApi.queryWorkflowSpecifications: " + e.Message ); + } + } + } +} +</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraworkflowSpecifications-queryWorkflowSpecifications-0-php"> + <pre class="prettyprint"><code class="language-php"><?php +require_once(__DIR__ . '/vendor/autoload.php'); + +$api_instance = new Swagger\Client\Api\OnapsoinfraworkflowSpecificationsApi(); +$version = version_example; // String | +$resourceTarget = resourceTarget_example; // String | + +try { + $result = $api_instance->queryWorkflowSpecifications($version, $resourceTarget); + print_r($result); +} catch (Exception $e) { + echo 'Exception when calling OnapsoinfraworkflowSpecificationsApi->queryWorkflowSpecifications: ', $e->getMessage(), PHP_EOL; +} +?></code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraworkflowSpecifications-queryWorkflowSpecifications-0-perl"> + <pre class="prettyprint"><code class="language-perl">use Data::Dumper; +use WWW::SwaggerClient::Configuration; +use WWW::SwaggerClient::OnapsoinfraworkflowSpecificationsApi; + +my $api_instance = WWW::SwaggerClient::OnapsoinfraworkflowSpecificationsApi->new(); +my $version = version_example; # String | +my $resourceTarget = resourceTarget_example; # String | + +eval { + my $result = $api_instance->queryWorkflowSpecifications(version => $version, resourceTarget => $resourceTarget); + print Dumper($result); +}; +if ($@) { + warn "Exception when calling OnapsoinfraworkflowSpecificationsApi->queryWorkflowSpecifications: $@\n"; +}</code></pre> + </div> + + <div class="tab-pane" id="examples-OnapsoinfraworkflowSpecifications-queryWorkflowSpecifications-0-python"> + <pre class="prettyprint"><code class="language-python">from __future__ import print_statement +import time +import swagger_client +from swagger_client.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = swagger_client.OnapsoinfraworkflowSpecificationsApi() +version = version_example # String | +resourceTarget = resourceTarget_example # String | (optional) + +try: + # Retrieve Workflow details based on the filter criteria + api_response = api_instance.query_workflow_specifications(version, resourceTarget=resourceTarget) + pprint(api_response) +except ApiException as e: + print("Exception when calling OnapsoinfraworkflowSpecificationsApi->queryWorkflowSpecifications: %s\n" % e)</code></pre> + </div> + </div> + + <h2>Parameters</h2> + + <div class="methodsubtabletitle">Path parameters</div> + <table id="methodsubtable"> + <tr> + <th width="150px">Name</th> + <th>Description</th> + </tr> + <tr><td style="width:150px;">version*</td> +<td> + + + <div id="d2e199_queryWorkflowSpecifications_version"> + <div class="json-schema-view"> + <div class="primitive"> + <span class="type"> + String + </span> + + </div> + <div class="inner required"> + Required + </div> + </div> + </div> +</td> +</tr> + + </table> + + + + + <div class="methodsubtabletitle">Query parameters</div> + <table id="methodsubtable"> + <tr> + <th width="150px">Name</th> + <th>Description</th> + </tr> + <tr><td style="width:150px;">resourceTarget</td> +<td> + + + <div id="d2e199_queryWorkflowSpecifications_resourceTarget"> + <div class="json-schema-view"> + <div class="primitive"> + <span class="type"> + String + </span> + + </div> + </div> + </div> +</td> +</tr> + + </table> + + <h2>Responses</h2> + <h3> Status: default - List of workflow specifications on successful operation </h3> + + <ul class="nav nav-tabs nav-tabs-examples" > + <li class="active"> + <a data-toggle="tab" href="#responses-queryWorkflowSpecifications-default-schema">Schema</a> + </li> + + </ul> + + <div class="tab-content" style='margin-bottom: 10px;'> + <div class="tab-pane active" id="responses-queryWorkflowSpecifications-default-schema"> + <div id='responses-queryWorkflowSpecifications-default-schema-default' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;"> + <script> + $(document).ready(function() { + var schemaWrapper = { + "description" : "List of workflow specifications on successful operation", + "schema" : { + "$ref" : "#/definitions/RetrievingWorkflowResponse" + } +}; + var schema = schemaWrapper.schema; + if (schema.$ref != null) { + schema = defsParser.$refs.get(schema.$ref); + } else { + schemaWrapper.definitions = defs; + $RefParser.dereference(schemaWrapper).catch(function(err) { + console.log(err); + }); + } + + //console.log(JSON.stringify(schema)); + var view = new JSONSchemaView(schema, 3); + $('#responses-queryWorkflowSpecifications-default-schema-data').val(stringify(schema)); + var result = $('#responses-queryWorkflowSpecifications-default-schema-default'); + result.empty(); + result.append(view.render()); + }); + </script> + </div> + <input id='responses-queryWorkflowSpecifications-default-schema-data' type='hidden' value=''></input> + </div> + </div> + + </article> + </div> + <hr> + </section> </div> <div id="footer"> <div id="api-_footer"> @@ -17636,11 +23183,6 @@ except ApiException as e: <div class="license-url">http://apache.org/licenses/LICENSE-2.0.html</div> </div> </div> - <div id="generator"> - <div class="content"> - Generated 2018-11-19T03:11:19.743Z - </div> - </div> </div> </div> </div> @@ -18835,6 +24377,12 @@ var JSONSchemaView = (function () { return this.element; } + if (this.schema && this.schema.example) { + var exampleDiv = document.createElement('div'); + exampleDiv.innerHTML = '<div style="display: block" class="example">\n <span style="color: #808080" class="name">example: ' + this.schema.example + '</span>\n </div>'; + this.element.appendChild(exampleDiv.querySelector('.example')); + } + if (!this.isCollapsed) { this.appendChildren(this.element); } @@ -19361,7 +24909,7 @@ g,0<c.length&&(c=Aa[c[0]])&&(a.c[e]=c))}a.c[e]||(c=Aa[e])&&(a.c[e]=c);for(c=0;c< <script> var schemaWrapper = {}; - schemaWrapper.definitions = Object.assign({}, defs); + schemaWrapper.definitions = defs; defsParser = new $RefParser(); defsParser.dereference(schemaWrapper).catch(function(err) { console.log(err); diff --git a/docs/api/swagger/swagger.json b/docs/api/swagger/swagger.json index 5051ba19e9..4ec404e0bd 100644 --- a/docs/api/swagger/swagger.json +++ b/docs/api/swagger/swagger.json @@ -9,7 +9,7 @@ "name": "e2eServiceInstances" }, { - "name": "3gppservices" + "name": "Onap3gppServiceInstances" }, { "name": "globalhealthcheck" @@ -21,6 +21,9 @@ "name": "onapsoinfraorchestrationRequests" }, { + "name": "onapsoinfraorchestrationTasks" + }, + { "name": "onapsoinfraserviceInstantiation" }, { @@ -34,6 +37,12 @@ }, { "name": "onapsoinframodelDistributions" + }, + { + "name": "onapsoinfraworkflowSpecifications" + }, + { + "name": "onapsoinfrainstanceManagement" } ], "schemes": [ @@ -164,6 +173,57 @@ } } }, + "/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/{operationType}": { + "post": { + "tags": [ + "e2eServiceInstances" + ], + "summary": "Activate/Deactivate 5G slice Service on a specified version and serviceId", + "description": "", + "operationId": "activateE2EServiceInstances", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "pattern": "[vV][3-5]" + }, + { + "name": "serviceId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "operationType", + "in": "path", + "required": true, + "type": "string", + "pattern": "activate/deactivate" + } + ], + "responses": { + "default": { + "description": "successful operation" + } + } + } + }, "/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/operations/{operationId}": { "get": { "tags": [ @@ -294,7 +354,7 @@ "/onap/so/infra/3gppservices/{version}/allocate": { "post": { "tags": [ - "3gppservices" + "Onap3gppServiceInstances" ], "summary": "Create a 3GPP Service Instance on a version provided", "description": "", @@ -335,7 +395,7 @@ "/onap/so/infra/3gppservices/{version}/deAllocate": { "delete": { "tags": [ - "3gppservices" + "Onap3gppServiceInstances" ], "summary": "Terminate/Deallocate a 3GPP Service Instance on a version provided", "description": "", @@ -376,7 +436,7 @@ "/onap/so/infra/3gppservices/{version}/modify": { "put": { "tags": [ - "3gppservices" + "Onap3gppServiceInstances" ], "summary": "Modify a 3GPP Service Instance on a version provided", "description": "", @@ -417,7 +477,7 @@ "/onap/so/infra/3gppservices/{version}/activate": { "post": { "tags": [ - "3gppservices" + "Onap3gppServiceInstances" ], "summary": "Activate a 3GPP Service Instance on a version provided", "description": "", @@ -458,7 +518,7 @@ "/onap/so/infra/3gppservices/{version}/deActivate": { "post": { "tags": [ - "3gppservices" + "Onap3gppServiceInstances" ], "summary": "Deactivate a 3GPP Service Instance on a version provided", "description": "", @@ -499,7 +559,7 @@ "/onap/so/infra/3gppservices/{version}/subnetCapabilityQuery": { "get": { "tags": [ - "3gppservices" + "Onap3gppServiceInstances" ], "summary": "Provides subnet capability based on subnet types", "description": "", @@ -687,6 +747,251 @@ } } }, + "/onap/so/infra/orchestrationTasks/{version}": { + "get": { + "tags": [ + "onapsoinfraorchestrationTasks" + ], + "summary": "Get all orchestrationTasks", + "description": "", + "operationId": "getAllOrchestrationTasks", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "pattern": "[vV][4-7]" + } + ], + "responses": { + "default": { + "description": "successful operation" + } + } + }, + "post": { + "tags": [ + "onapsoinfraorchestrationTasks" + ], + "summary": "Create an orchestrationTask", + "description": "", + "operationId": "createOrchestrationTask", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "pattern": "[vV][4-7]" + } + ], + "responses": { + "default": { + "description": "successful operation" + } + } + } + }, + "/onap/so/infra/orchestrationTasks/{version}/{taskId}": { + "get": { + "tags": [ + "onapsoinfraorchestrationTasks" + ], + "summary": "Get orchestrationTask for a given taskId", + "description": "", + "operationId": "getOrchestrationTask", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "taskId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "pattern": "[vV][4-7]" + } + ], + "responses": { + "default": { + "description": "successful operation" + } + } + }, + "put": { + "tags": [ + "onapsoinfraorchestrationTasks" + ], + "summary": "update orchestrationTask for a given taskId", + "description": "", + "operationId": "updateOrchestrationTask", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "taskId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "pattern": "[vV][4-7]" + }, + { + "in": "body", + "name": "body", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "successful operation" + } + } + }, + "delete": { + "tags": [ + "onapsoinfraorchestrationTasks" + ], + "summary": "delete orchestrationTask for a given taskId", + "description": "", + "operationId": "deleteOrchestrationTask", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "taskId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "pattern": "[vV][4-7]" + } + ], + "responses": { + "default": { + "description": "successful operation" + } + } + } + }, + "/onap/so/infra/orchestrationTasks/{version}/{taskId}/commit": { + "post": { + "tags": [ + "onapsoinfraorchestrationTasks" + ], + "summary": "commit orchestrationTask for a given taskId", + "description": "", + "operationId": "commitOrchestrationTask", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "taskId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "pattern": "[vV][4-7]" + } + ], + "responses": { + "default": { + "description": "successful operation" + } + } + } + }, + "/onap/so/infra/orchestrationTasks/{version}/{taskId}/abort": { + "post": { + "tags": [ + "onapsoinfraorchestrationTasks" + ], + "summary": "abort orchestrationTask for a given taskId", + "description": "", + "operationId": "abortOrchestrationTask", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "taskId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "pattern": "[vV][4-7]" + } + ], + "responses": { + "default": { + "description": "successful operation" + } + } + } + }, "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}/deactivateAndCloudDelete": { "post": { "tags": [ @@ -2546,6 +2851,95 @@ } } } + }, + "/onap/so/infra/workflowSpecifications/{version}/workflows": { + "get": { + "tags": [ + "onapsoinfraworkflowSpecifications" + ], + "summary": "Retrieve Workflow details based on the filter criteria", + "description": "", + "operationId": "queryWorkflowSpecifications", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "resourceTarget", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "pattern": "[vV][1]" + } + ], + "responses": { + "default": { + "description": "List of workflow specifications on successful operation", + "schema": { + "$ref": "#/definitions/RetrievingWorkflowResponse" + } + } + } + } + }, + "/onap/so/infra/instanceManagement/{version}/serviceInstances/{serviceInstanceId}/workflows/{workflow_UUID}": { + "post": { + "tags": [ + "onapsoinfrainstanceManagement" + ], + "summary": "Executing service level custom workflow", + "description": "", + "operationId": "executeServiceLevelCustomWorkflow", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ServiceLevelWorkflowExecution" + } + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "pattern": "[vV][1]" + }, + { + "name": "serviceInstanceId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "workflow_UUID", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "default": { + "description": "successful operation" + } + } + } } }, "definitions": { @@ -2678,11 +3072,11 @@ "type": "string", "enum": [ "AN", - "AN-NF", + "AN_NF", "CN", - "TN-FH", - "TN-MH", - "TN-BH" + "TN_FH", + "TN_MH", + "TN_BH" ] }, "3gppServiceResponse": { @@ -2699,9 +3093,169 @@ }, "statusDescription": { "description": "Description on status in case of erroneous response", - "type": "string" + "type": "object" + } + } + }, + "RetrievingWorkflowResponse": { + "description": "Response body of fetching workflows using resource target", + "type": "object", + "properties": { + "workflowSpecificationList":{ + "description": "List of Workflow specification data", + "type": "array", + "items": { + "$ref": "#/definitions/WorkflowSpecification" + } + } + } + }, + "WorkflowSpecification": { + "description": "This describes workflow specification object", + "type": "object", + "properties": { + "artifactInfo": { + "description": "Attributes related to artifact information ", + "type": "object", + "properties": { + "artifactType": { + "description": "Type of the artifact to be queried", + "type": "string" + }, + "artifactUuid": { + "description": "UUID of the artifact", + "type": "string" + }, + "artifactName": { + "description": "Name of the artifact", + "type": "string" + }, + "artifactVersion": { + "description": "Artifact's Version", + "type": "string" + }, + "artifactDescription": { + "description": "", + "type": "string" + }, + "workflowName": { + "description": "Name of the workflow fetched for the resource type", + "type": "string" + }, + "operationName": { + "description": "Mapped operation name of the corresponding workflow", + "type": "string" + }, + "workflowSource": { + "description": "", + "type": "string" + }, + "workflowResourceTarget": { + "description": "Type of Resource mapped against the workflow", + "type": "string" + } + } + } + } + }, + "ServiceLevelWorkflowExecution": { + "description": "This describes the request body of service level custom workflow execution", + "type": "object", + "properties": { + "requestInfo": { + "description": "Request object contains source information", + "type": "object", + "properties": { + "source": { + "description": "Name of the sender", + "type": "string" + }, + "suppressRollback": { + "description": "Enable/disable rollback suppression", + "type": "boolean" + }, + "requestorId": { + "description": "Id of the sender", + "type": "string" + } + } + }, + "modelInfo": { + "description": "Parameters related to the service model", + "type": "object", + "properties": { + "modelType": { + "description": "Type of the model to be executed", + "type": "string" + }, + "modelInvariantUuid": { + "description": "Model invariant id corresponding to the service", + "type": "string" + }, + "modelUuid": { + "description": "Model uuid corresponding to the service", + "type": "string" + }, + "modelVersionId": { + "description": "Model version of the service instance", + "type": "string" + }, + "modelName": { + "description": "Name of the service", + "type": "string" + }, + "modelVersion": { + "description": "Version of the service instance", + "type": "string" + } + } + }, + "requestParameters": { + "description": "User parameter object", + "type": "object", + "properties": { + "subscriptionServiceType": { + "description": "Type of service subscription", + "type": "string" + } + } + }, + "subscriberInfo": { + "description": "Subscriber id information", + "type": "object", + "properties": { + "globalSubscriberId": { + "description": "Id of the subscriber sending the request", + "type": "string" + } + } + }, + "project": { + "description": "Information about the target project name", + "type": "object", + "properties": { + "projectName":{ + "description": "Name of the target project", + "type": "string" + } + } + }, + "owningEntity": { + "description": "Object describes the entity details", + "type": "object", + "properties": { + "owningEntityId": { + "description": "Id of the owning Entity", + "type": "string" + }, + "owningEntityName": { + "description": "Name of the owning Entity", + "type": "string" + } + } } + } } } -} +}
\ No newline at end of file diff --git a/docs/api/swagger/swagger.yaml b/docs/api/swagger/swagger.yaml index 049436f954..181a8df756 100644 --- a/docs/api/swagger/swagger.yaml +++ b/docs/api/swagger/swagger.yaml @@ -4,15 +4,18 @@ info: title: SO Guilin APIs tags: - name: e2eServiceInstances - - name: 3gppservices + - name: Onap3gppServiceInstances - name: globalhealthcheck - name: nodehealthcheck - name: onapsoinfraorchestrationRequests + - name: onapsoinfraorchestrationTasks - name: onapsoinfraserviceInstantiation - name: onapsoinfratasks - name: onapsoinfracloudResources - name: onapsoinfracloudResourcesRequests - name: onapsoinframodelDistributions + - name: onapsoinfraworkflowSpecifications + - name: onapsoinfrainstanceManagement schemes: - http paths: @@ -98,6 +101,42 @@ paths: responses: default: description: successful operation + '/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/{operationType}': + post: + tags: + - e2eServiceInstances + summary: >- + Activate/Deactivate 5G slice Service on a specified version and + serviceId + description: '' + operationId: activateE2EServiceInstances + consumes: + - application/json + produces: + - application/json + parameters: + - in: body + name: body + required: false + schema: + type: string + - name: version + in: path + required: true + type: string + pattern: '[vV][3-5]' + - name: serviceId + in: path + required: true + type: string + - name: operationType + in: path + required: true + type: string + pattern: activate/deactivate + responses: + default: + description: successful operation '/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/operations/{operationId}': get: tags: @@ -159,7 +198,7 @@ paths: - e2eServiceInstances summary: >- Find added and deleted resources of target model for the - e2eserviceInstance on a given serviceId + e2eserviceInstance on a given serviceId description: '' operationId: compareModelwithTargetVersion consumes: @@ -187,7 +226,7 @@ paths: '/onap/so/infra/3gppservices/{version}/allocate': post: tags: - - 3gppservices + - Onap3gppServiceInstances summary: Create a 3GPP Service Instance on a version provided description: '' operationId: allocate3gppService @@ -214,7 +253,7 @@ paths: '/onap/so/infra/3gppservices/{version}/deAllocate': delete: tags: - - 3gppservices + - Onap3gppServiceInstances summary: Terminate/Deallocate a 3GPP Service Instance on a version provided description: '' operationId: deallocate3gppService @@ -241,7 +280,7 @@ paths: '/onap/so/infra/3gppservices/{version}/modify': put: tags: - - 3gppservices + - Onap3gppServiceInstances summary: Modify a 3GPP Service Instance on a version provided description: '' operationId: modify3gppService @@ -268,7 +307,7 @@ paths: '/onap/so/infra/3gppservices/{version}/activate': post: tags: - - 3gppservices + - Onap3gppServiceInstances summary: Activate a 3GPP Service Instance on a version provided description: '' operationId: activate3gppService @@ -295,7 +334,7 @@ paths: '/onap/so/infra/3gppservices/{version}/deActivate': post: tags: - - 3gppservices + - Onap3gppServiceInstances summary: Deactivate a 3GPP Service Instance on a version provided description: '' operationId: deactivate3gppService @@ -322,7 +361,7 @@ paths: '/onap/so/infra/3gppservices/{version}/subnetCapabilityQuery': get: tags: - - 3gppservices + - Onap3gppServiceInstances summary: Provides subnet capability based on subnet types description: '' operationId: querySubnetCapability @@ -446,6 +485,169 @@ paths: responses: default: description: successful operation + '/onap/so/infra/orchestrationTasks/{version}': + get: + tags: + - onapsoinfraorchestrationTasks + summary: Get all orchestrationTasks + description: '' + operationId: getAllOrchestrationTasks + produces: + - application/json + parameters: + - name: version + in: path + required: true + type: string + pattern: '[vV][4-7]' + responses: + default: + description: successful operation + post: + tags: + - onapsoinfraorchestrationTasks + summary: Create an orchestrationTask + description: '' + operationId: createOrchestrationTask + produces: + - application/json + parameters: + - in: body + name: body + required: false + schema: + type: string + - name: version + in: path + required: true + type: string + pattern: '[vV][4-7]' + responses: + default: + description: successful operation + '/onap/so/infra/orchestrationTasks/{version}/{taskId}': + get: + tags: + - onapsoinfraorchestrationTasks + summary: Get orchestrationTask for a given taskId + description: '' + operationId: getOrchestrationTask + produces: + - application/json + parameters: + - name: taskId + in: path + required: true + type: string + - name: version + in: path + required: true + type: string + pattern: '[vV][4-7]' + responses: + default: + description: successful operation + put: + tags: + - onapsoinfraorchestrationTasks + summary: update orchestrationTask for a given taskId + description: '' + operationId: updateOrchestrationTask + produces: + - application/json + parameters: + - name: taskId + in: path + required: true + type: string + - name: version + in: path + required: true + type: string + pattern: '[vV][4-7]' + - in: body + name: body + required: false + schema: + type: string + responses: + default: + description: successful operation + delete: + tags: + - onapsoinfraorchestrationTasks + summary: delete orchestrationTask for a given taskId + description: '' + operationId: deleteOrchestrationTask + produces: + - application/json + parameters: + - name: taskId + in: path + required: true + type: string + - name: version + in: path + required: true + type: string + pattern: '[vV][4-7]' + responses: + default: + description: successful operation + '/onap/so/infra/orchestrationTasks/{version}/{taskId}/commit': + post: + tags: + - onapsoinfraorchestrationTasks + summary: commit orchestrationTask for a given taskId + description: '' + operationId: commitOrchestrationTask + produces: + - application/json + parameters: + - in: body + name: body + required: false + schema: + type: string + - name: taskId + in: path + required: true + type: string + - name: version + in: path + required: true + type: string + pattern: '[vV][4-7]' + responses: + default: + description: successful operation + '/onap/so/infra/orchestrationTasks/{version}/{taskId}/abort': + post: + tags: + - onapsoinfraorchestrationTasks + summary: abort orchestrationTask for a given taskId + description: '' + operationId: abortOrchestrationTask + produces: + - application/json + parameters: + - in: body + name: body + required: false + schema: + type: string + - name: taskId + in: path + required: true + type: string + - name: version + in: path + required: true + type: string + pattern: '[vV][4-7]' + responses: + default: + description: successful operation '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}/deactivateAndCloudDelete': post: tags: @@ -1681,6 +1883,65 @@ paths: responses: default: description: successful operation + '/onap/so/infra/workflowSpecifications/{version}/workflows': + get: + tags: + - onapsoinfraworkflowSpecifications + summary: Retrieve Workflow details based on the filter criteria + description: '' + operationId: queryWorkflowSpecifications + consumes: + - application/json + produces: + - application/json + parameters: + - name: resourceTarget + in: query + required: false + type: string + - name: version + in: path + required: true + type: string + pattern: '[vV][1]' + responses: + default: + description: List of workflow specifications on successful operation + schema: + $ref: '#/definitions/RetrievingWorkflowResponse' + '/onap/so/infra/instanceManagement/{version}/serviceInstances/{serviceInstanceId}/workflows/{workflow_UUID}': + post: + tags: + - onapsoinfrainstanceManagement + summary: Executing service level custom workflow + description: '' + operationId: executeServiceLevelCustomWorkflow + consumes: + - application/json + produces: + - application/json + parameters: + - in: body + name: body + required: false + schema: + $ref: '#/definitions/ServiceLevelWorkflowExecution' + - name: version + in: path + required: true + type: string + pattern: '[vV][1]' + - name: serviceInstanceId + in: path + required: true + type: string + - name: workflow_UUID + in: path + required: true + type: string + responses: + default: + description: successful operation definitions: Allocate3gppService: description: This describes the request body for 3gpp service allocation @@ -1782,11 +2043,11 @@ definitions: type: string enum: - AN - - AN-NF + - AN_NF - CN - - TN-FH - - TN-MH - - TN-BH + - TN_FH + - TN_MH + - TN_BH 3gppServiceResponse: description: This describes the response for 3gpp services type: object @@ -1799,4 +2060,118 @@ definitions: type: string statusDescription: description: Description on status in case of erroneous response - type: string + type: object + RetrievingWorkflowResponse: + description: Response body of fetching workflows using resource target + type: object + properties: + workflowSpecificationList: + description: List of Workflow specification data + type: array + items: + $ref: '#/definitions/WorkflowSpecification' + WorkflowSpecification: + description: This describes workflow specification object + type: object + properties: + artifactInfo: + description: 'Attributes related to artifact information ' + type: object + properties: + artifactType: + description: Type of the artifact to be queried + type: string + artifactUuid: + description: UUID of the artifact + type: string + artifactName: + description: Name of the artifact + type: string + artifactVersion: + description: Artifact's Version + type: string + artifactDescription: + description: '' + type: string + workflowName: + description: Name of the workflow fetched for the resource type + type: string + operationName: + description: Mapped operation name of the corresponding workflow + type: string + workflowSource: + description: '' + type: string + workflowResourceTarget: + description: Type of Resource mapped against the workflow + type: string + ServiceLevelWorkflowExecution: + description: This describes the request body of service level custom workflow execution + type: object + properties: + requestInfo: + description: Request object contains source information + type: object + properties: + source: + description: Name of the sender + type: string + suppressRollback: + description: Enable/disable rollback suppression + type: boolean + requestorId: + description: Id of the sender + type: string + modelInfo: + description: Parameters related to the service model + type: object + properties: + modelType: + description: Type of the model to be executed + type: string + modelInvariantUuid: + description: Model invariant id corresponding to the service + type: string + modelUuid: + description: Model uuid corresponding to the service + type: string + modelVersionId: + description: Model version of the service instance + type: string + modelName: + description: Name of the service + type: string + modelVersion: + description: Version of the service instance + type: string + requestParameters: + description: User parameter object + type: object + properties: + subscriptionServiceType: + description: Type of service subscription + type: string + subscriberInfo: + description: Subscriber id information + type: object + properties: + globalSubscriberId: + description: Id of the subscriber sending the request + type: string + project: + description: Information about the target project name + type: object + properties: + projectName: + description: Name of the target project + type: string + owningEntity: + description: Object describes the entity details + type: object + properties: + owningEntityId: + description: Id of the owning Entity + type: string + owningEntityName: + description: Name of the owning Entity + type: string |