From 280f8015d06af1f41a3ef12e8300801c7a5e0d54 Mon Sep 17 00:00:00 2001 From: AviZi Date: Fri, 9 Jun 2017 02:39:56 +0300 Subject: [SDC-29] Amdocs OnBoard 1707 initial commit. Change-Id: Ie4d12a3f574008b792899b368a0902a8b46b5370 Signed-off-by: AviZi --- openecomp-be/tools/swagger-ui/api-docs/api.html | 13140 ------------------- openecomp-be/tools/swagger-ui/api-docs/api.json | 4676 ------- openecomp-be/tools/swagger-ui/lang/en.js | 20 - openecomp-be/tools/swagger-ui/lang/es.js | 20 - openecomp-be/tools/swagger-ui/lang/ja.js | 76 +- openecomp-be/tools/swagger-ui/lang/pt.js | 20 - openecomp-be/tools/swagger-ui/lang/ru.js | 62 +- openecomp-be/tools/swagger-ui/lang/tr.js | 20 - openecomp-be/tools/swagger-ui/lang/translator.js | 20 - openecomp-be/tools/swagger-ui/lang/zh-cn.js | 86 +- openecomp-be/tools/swagger-ui/lib/backbone-min.js | 22 +- .../tools/swagger-ui/lib/handlebars-2.0.0.js | 22 +- .../tools/swagger-ui/lib/highlight.7.3.pack.js | 22 +- .../tools/swagger-ui/lib/jquery-1.8.0.min.js | 22 +- .../tools/swagger-ui/lib/jquery.ba-bbq.min.js | 22 +- .../tools/swagger-ui/lib/jquery.slideto.min.js | 20 - .../tools/swagger-ui/lib/jquery.wiggle.min.js | 22 +- openecomp-be/tools/swagger-ui/lib/marked.js | 22 +- openecomp-be/tools/swagger-ui/lib/swagger-oauth.js | 20 - .../tools/swagger-ui/lib/underscore-min.js | 22 +- .../tools/swagger-ui/lib/underscore-min.map | 2 +- openecomp-be/tools/swagger-ui/pom.xml | 38 +- openecomp-be/tools/swagger-ui/swagger-ui.js | 26 +- openecomp-be/tools/swagger-ui/swagger-ui.min.js | 24 +- 24 files changed, 130 insertions(+), 18316 deletions(-) delete mode 100644 openecomp-be/tools/swagger-ui/api-docs/api.html delete mode 100644 openecomp-be/tools/swagger-ui/api-docs/api.json (limited to 'openecomp-be/tools/swagger-ui') diff --git a/openecomp-be/tools/swagger-ui/api-docs/api.html b/openecomp-be/tools/swagger-ui/api-docs/api.html deleted file mode 100644 index b89547e308..0000000000 --- a/openecomp-be/tools/swagger-ui/api-docs/api.html +++ /dev/null @@ -1,13140 +0,0 @@ - - -API Document - - - -#Rest API - - -## HTTP:///onboarding-api - - -Rest API Documentation - - - -**Version** v1.0, build #${buildNumber} - - - - - - - - - - - - -# APIs - - -## /v1.0/application-configuration - - - - - - -### POST - - -<a id="insertToTable">Insert JSON schema into application config table</a> - - - - - - - - - -#### Request - - -**Content-Type: ** multipart/form-data - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>namespace</th> - <td>query</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>key</th> - <td>query</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - <a href="#/definitions/InputStream">InputStream</a> - </td> - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - - - - -## /v1.0/application-configuration/{namespace} - - -### GET - -<a id="getListOfConfigurationByNamespaceFromTable">Get List of keys and values by namespace</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>namespace</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - - - - - - - -## /v1.0/application-configuration/{namespace}/{key} - - -### GET - -<a id="getFromTable">Get JSON schema by namespace and key</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>namespace</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>key</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| 200 | successful operation | <a href="#/definitions/ConfigurationDataDto">ConfigurationDataDto</a>| - - - - - - - - - - - - - - - - - -## /v1.0/validation/{type}/validate - - - - - - -### POST - - -<a id="validateFile">Validate a package</a> - - - - - - - - - -#### Request - - -**Content-Type: ** multipart/form-data - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>type</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - <a href="#/definitions/InputStream">InputStream</a> - </td> - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - - - - -## /v1.0/vendor-license-models - - -### GET - -<a id="listLicenseModels">List vendor license models</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>versionFilter</th> - <td>query</td> - <td>no</td> - <td>Currently supported value: &#x27;Final&#x27; - only vendor License models with final versions will be return - with their latest final version</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| 200 | successful operation | Array[<a href="#/definitions/VendorLicenseModelEntity">VendorLicenseModelEntity</a>]| - - - - - - -### POST - - -<a id="createLicenseModel">Create vendor license model</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - <a href="#/definitions/VendorLicenseModelRequest">VendorLicenseModelRequest</a> - </td> - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - - - - -## /v1.0/vendor-license-models/{vlmId} - - -### GET - -<a id="getLicenseModel">Get vendor license model</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vlmId</th> - <td>path</td> - <td>yes</td> - <td>Vendor license model Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>version</th> - <td>query</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| 200 | successful operation | <a href="#/definitions/VendorLicenseModelEntity">VendorLicenseModelEntity</a>| - - - - -### PUT - -<a id="updateLicenseModel">Update vendor license model</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - <a href="#/definitions/VendorLicenseModelRequest">VendorLicenseModelRequest</a> - </td> - -</tr> - -<tr> - <th>vlmId</th> - <td>path</td> - <td>yes</td> - <td>Vendor license model Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - -### DELETE - -<a id="deleteLicenseModel">Delete vendor license model</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vlmId</th> - <td>path</td> - <td>yes</td> - <td>Vendor license model Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - -## /v1.0/vendor-license-models/{vlmId}/actions - - - - -### PUT - -<a id="actOnLicenseModel">Update vendor license model</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - <a href="#/definitions/VendorLicenseModelActionRequestDto">VendorLicenseModelActionRequestDto</a> - </td> - -</tr> - -<tr> - <th>vlmId</th> - <td>path</td> - <td>yes</td> - <td>Vendor license model Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - - - - - -## /v1.0/vendor-license-models/{vlmId}/entitlement-pools - - -### GET - -<a id="listEntitlementPools">List vendor entitlement pools</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vlmId</th> - <td>path</td> - <td>yes</td> - <td>Vendor license model Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>version</th> - <td>query</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| 200 | successful operation | Array[<a href="#/definitions/EntitlementPoolEntity">EntitlementPoolEntity</a>]| - - - - - - -### POST - - -<a id="createEntitlementPool">Create vendor entitlement pool</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - <a href="#/definitions/EntitlementPoolRequest">EntitlementPoolRequest</a> - </td> - -</tr> - -<tr> - <th>vlmId</th> - <td>path</td> - <td>yes</td> - <td>Vendor license model Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - - - - -## /v1.0/vendor-license-models/{vlmId}/entitlement-pools/{entitlementPoolId} - - -### GET - -<a id="getEntitlementPool">Get vendor entitlement pool</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vlmId</th> - <td>path</td> - <td>yes</td> - <td>Vendor license model Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>version</th> - <td>query</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>entitlementPoolId</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| 200 | successful operation | <a href="#/definitions/EntitlementPoolEntity">EntitlementPoolEntity</a>| - - - - -### PUT - -<a id="updateEntitlementPool">Update vendor entitlement pool</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - <a href="#/definitions/EntitlementPoolRequest">EntitlementPoolRequest</a> - </td> - -</tr> - -<tr> - <th>vlmId</th> - <td>path</td> - <td>yes</td> - <td>Vendor license model Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>entitlementPoolId</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - -### DELETE - -<a id="deleteEntitlementPool">Delete vendor entitlement pool</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vlmId</th> - <td>path</td> - <td>yes</td> - <td>Vendor license model Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>entitlementPoolId</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - -## /v1.0/vendor-license-models/{vlmId}/feature-groups - - -### GET - -<a id="listFeatureGroups">List vendor feature groups</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vlmId</th> - <td>path</td> - <td>yes</td> - <td>Vendor license model Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>version</th> - <td>query</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| 200 | successful operation | Array[<a href="#/definitions/FeatureGroupEntity">FeatureGroupEntity</a>]| - - - - - - -### POST - - -<a id="createFeatureGroup">Create vendor feature group</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - <a href="#/definitions/FeatureGroupRequest">FeatureGroupRequest</a> - </td> - -</tr> - -<tr> - <th>vlmId</th> - <td>path</td> - <td>yes</td> - <td>Vendor license model Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - - - - -## /v1.0/vendor-license-models/{vlmId}/feature-groups/{featureGroupId} - - -### GET - -<a id="getFeatureGroup">Get vendor feature group</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vlmId</th> - <td>path</td> - <td>yes</td> - <td>Vendor license model Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>version</th> - <td>query</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>featureGroupId</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| 200 | successful operation | <a href="#/definitions/FeatureGroupModel">FeatureGroupModel</a>| - - - - -### PUT - -<a id="updateFeatureGroup">Update vendor feature group</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - <a href="#/definitions/FeatureGroupUpdateRequest">FeatureGroupUpdateRequest</a> - </td> - -</tr> - -<tr> - <th>vlmId</th> - <td>path</td> - <td>yes</td> - <td>Vendor license model Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>featureGroupId</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - -### DELETE - -<a id="deleteFeatureGroup">Delete vendor feature group</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vlmId</th> - <td>path</td> - <td>yes</td> - <td>Vendor license model Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>featureGroupId</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - -## /v1.0/vendor-license-models/{vlmId}/license-agreements - - -### GET - -<a id="listLicenseAgreements">List vendor license agreements</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vlmId</th> - <td>path</td> - <td>yes</td> - <td>Vendor license model Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>version</th> - <td>query</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| 200 | successful operation | Array[<a href="#/definitions/LicenseAgreementEntity">LicenseAgreementEntity</a>]| - - - - - - -### POST - - -<a id="createLicenseAgreement">Create vendor license agreement</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - <a href="#/definitions/LicenseAgreementRequest">LicenseAgreementRequest</a> - </td> - -</tr> - -<tr> - <th>vlmId</th> - <td>path</td> - <td>yes</td> - <td>Vendor license model Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - - - - -## /v1.0/vendor-license-models/{vlmId}/license-agreements/{licenseAgreementId} - - -### GET - -<a id="getLicenseAgreement">Get vendor license agreement</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vlmId</th> - <td>path</td> - <td>yes</td> - <td>Vendor license model Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>version</th> - <td>query</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>licenseAgreementId</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| 200 | successful operation | <a href="#/definitions/LicenseAgreementModel">LicenseAgreementModel</a>| - - - - -### PUT - -<a id="updateLicenseAgreement">Update vendor license agreement</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - <a href="#/definitions/LicenseAgreementUpdateRequest">LicenseAgreementUpdateRequest</a> - </td> - -</tr> - -<tr> - <th>vlmId</th> - <td>path</td> - <td>yes</td> - <td>Vendor license model Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>licenseAgreementId</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - -### DELETE - -<a id="deleteLicenseAgreement">Delete vendor license agreement</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vlmId</th> - <td>path</td> - <td>yes</td> - <td>Vendor license model Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>licenseAgreementId</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - -## /v1.0/vendor-license-models/{vlmId}/license-key-groups - - -### GET - -<a id="listLicenseKeyGroups">List vendor license key groups</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vlmId</th> - <td>path</td> - <td>yes</td> - <td>Vendor license model Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>version</th> - <td>query</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| 200 | successful operation | Array[<a href="#/definitions/LicenseKeyGroupEntityDto">LicenseKeyGroupEntityDto</a>]| - - - - - - -### POST - - -<a id="createLicenseKeyGroup">Create vendor license key group</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - <a href="#/definitions/LicenseKeyGroupRequestDto">LicenseKeyGroupRequestDto</a> - </td> - -</tr> - -<tr> - <th>vlmId</th> - <td>path</td> - <td>yes</td> - <td>Vendor license model Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - - - - -## /v1.0/vendor-license-models/{vlmId}/license-key-groups/{licenseKeyGroupId} - - -### GET - -<a id="getLicenseKeyGroup">Get vendor license key group</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vlmId</th> - <td>path</td> - <td>yes</td> - <td>Vendor license model Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>version</th> - <td>query</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>licenseKeyGroupId</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| 200 | successful operation | <a href="#/definitions/LicenseKeyGroupEntityDto">LicenseKeyGroupEntityDto</a>| - - - - -### PUT - -<a id="updateLicenseKeyGroup">Update vendor license key group</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - <a href="#/definitions/LicenseKeyGroupRequestDto">LicenseKeyGroupRequestDto</a> - </td> - -</tr> - -<tr> - <th>vlmId</th> - <td>path</td> - <td>yes</td> - <td>Vendor license model Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>licenseKeyGroupId</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - -### DELETE - -<a id="deleteLicenseKeyGroup">Delete vendor license key group</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vlmId</th> - <td>path</td> - <td>yes</td> - <td>Vendor license model Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>licenseKeyGroupId</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - -## /v1.0/vendor-software-products - - -### GET - -<a id="getVspList">Get list of vendor software products and their description</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>versionFilter</th> - <td>query</td> - <td>no</td> - <td>Currently supported values: &#x27;Final&#x27; - only vendor software products with final version will be return - with their latest final version</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - -### POST - - -<a id="createNewVsp">Create a new vendor software product</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - <a href="#/definitions/VspDescriptionDto">VspDescriptionDto</a> - </td> - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| 200 | successful operation | <a href="#/definitions/VspCreationDto">VspCreationDto</a>| - - - - - - - - - - - - - - -## /v1.0/vendor-software-products/packages - - -### GET - -<a id="listPackages">Get list of translated CSAR files details</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>category</th> - <td>query</td> - <td>no</td> - <td>Category</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>subCategory</th> - <td>query</td> - <td>no</td> - <td>Sub-category</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| 200 | successful operation | Array[<a href="#/definitions/PackageInfoDto">PackageInfoDto</a>]| - - - - - - - - - - - - - - - - - -## /v1.0/vendor-software-products/packages/{vspId} - - -### GET - -<a id="getTranslatedFile">Get translated CSAR file</a> - -Exports translated file to a zip file - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>version</th> - <td>query</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/octet-stream - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| 200 | successful operation | <a href="#/definitions/File">File</a>| - - - - - - - - - - - - - - - - - -## /v1.0/vendor-software-products/{vspId} - - -### GET - -<a id="getVspDetails">Get details of a vendor software product</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>version</th> - <td>query</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - -### PUT - -<a id="updateVsp">Update an existing vendor software product</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - <a href="#/definitions/VspDescriptionDto">VspDescriptionDto</a> - </td> - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - -### DELETE - -<a id="deleteVsp">Deletes vendor software product by given id</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - -## /v1.0/vendor-software-products/{vspId}/actions - - - - -### PUT - -<a id="actOnVendorSoftwareProduct">Actions on a vendor software product</a> - -Performs one of the following actions on a vendor software product: |Checkout: Locks it for edits by other users. Only the locking user sees the edited version.|Undo_Checkout: Unlocks it and deletes the edits that were done.|Checkin: Unlocks it and activates the edited version to all users.| Submit: Finalize its active version.|Create_Package: Creates a CSAR zip file.| - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - <a href="#/definitions/VersionSoftwareProductActionRequestDto">VersionSoftwareProductActionRequestDto</a> - </td> - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - - - - - -## /v1.0/vendor-software-products/{vspId}/components - - -### GET - -<a id="list">List vendor software product components</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>version</th> - <td>query</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| 200 | successful operation | Array[<a href="#/definitions/ComponentDto">ComponentDto</a>]| - - - - - - -### POST - - -<a id="create">Create a vendor software product component</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - <a href="#/definitions/ComponentRequestDto">ComponentRequestDto</a> - </td> - -</tr> - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - -### DELETE - -<a id="deleteList">Delete vendor software product components</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - -## /v1.0/vendor-software-products/{vspId}/components/{componentId} - - -### GET - -<a id="get">Get vendor software product component</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>componentId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product component Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>version</th> - <td>query</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| 200 | successful operation | <a href="#/definitions/ComponentData">ComponentData</a>| - - - - -### PUT - -<a id="update">Update vendor software product component</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - <a href="#/definitions/ComponentRequestDto">ComponentRequestDto</a> - </td> - -</tr> - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>componentId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product component Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - -### DELETE - -<a id="delete">Delete vendor software product component</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>componentId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product component Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - -## /v1.0/vendor-software-products/{vspId}/components/{componentId}/monitors/snmp - - -### GET - -<a id="list">Get the filenames of uploaded MIB definitions</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>componentId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product component Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| 200 | successful operation | <a href="#/definitions/MibUploadStatusDto">MibUploadStatusDto</a>| - - - - - - - - -### DELETE - -<a id="deletePollMibFile">Delete vendor software product MIB Poll Definitions file</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>componentId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product component Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - -## /v1.0/vendor-software-products/{vspId}/components/{componentId}/monitors/snmp-trap - - - - - - - - -### DELETE - -<a id="deleteTrapMibFile">Delete vendor software product MIB Trap Definitions file</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>componentId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product component Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - -## /v1.0/vendor-software-products/{vspId}/components/{componentId}/monitors/snmp-trap/upload - - - - - - -### POST - - -<a id="uploadTrapMibFile">Upload vendor software product MIB Trap Definitions file</a> - - - - - - - - - -#### Request - - -**Content-Type: ** multipart/form-data - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - <a href="#/definitions/Attachment">Attachment</a> - </td> - -</tr> - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>componentId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product component Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - - - - -## /v1.0/vendor-software-products/{vspId}/components/{componentId}/monitors/snmp/upload - - - - - - -### POST - - -<a id="uploadPollMibFile">Upload vendor software product MIB Poll Definitions file</a> - - - - - - - - - -#### Request - - -**Content-Type: ** multipart/form-data - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - <a href="#/definitions/Attachment">Attachment</a> - </td> - -</tr> - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>componentId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product component Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - - - - -## /v1.0/vendor-software-products/{vspId}/components/{componentId}/nics - - -### GET - -<a id="list">List vendor software product component NICs</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>componentId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product component Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>version</th> - <td>query</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| 200 | successful operation | Array[<a href="#/definitions/NicDto">NicDto</a>]| - - - - - - -### POST - - -<a id="create">Create a vendor software product NIC</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - <a href="#/definitions/NicRequestDto">NicRequestDto</a> - </td> - -</tr> - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>componentId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product component Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - - - - -## /v1.0/vendor-software-products/{vspId}/components/{componentId}/nics/{nicId} - - -### GET - -<a id="get">Get vendor software product NIC</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>componentId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product component Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>nicId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product NIC Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>version</th> - <td>query</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| 200 | successful operation | <a href="#/definitions/NicDto">NicDto</a>| - - - - -### PUT - -<a id="update">Update vendor software product NIC</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - <a href="#/definitions/NicRequestDto">NicRequestDto</a> - </td> - -</tr> - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>componentId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product component Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>nicId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product NIC Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - -### DELETE - -<a id="delete">Delete vendor software product NIC</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>componentId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product component Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>nicId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product NIC Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - -## /v1.0/vendor-software-products/{vspId}/components/{componentId}/nics/{nicId}/questionnaire - - -### GET - -<a id="getQuestionnaire">Get vendor software product component NIC questionnaire</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>componentId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product component Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>nicId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product NIC Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>version</th> - <td>query</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| 200 | successful operation | <a href="#/definitions/QuestionnaireResponseDto">QuestionnaireResponseDto</a>| - - - - -### PUT - -<a id="updateQuestionnaire">Update vendor software product component NIC questionnaire</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - - </td> - -</tr> - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>componentId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product component Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>nicId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product NIC Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - - - - - -## /v1.0/vendor-software-products/{vspId}/components/{componentId}/processes - - -### GET - -<a id="list">List vendor software product component processes</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>componentId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product component Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>version</th> - <td>query</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| 200 | successful operation | Array[<a href="#/definitions/ProcessEntityDto">ProcessEntityDto</a>]| - - - - - - -### POST - - -<a id="create">Create a vendor software product process</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - <a href="#/definitions/ProcessRequestDto">ProcessRequestDto</a> - </td> - -</tr> - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>componentId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product component Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - -### DELETE - -<a id="deleteList">Delete vendor software product processes</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>componentId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product component Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - -## /v1.0/vendor-software-products/{vspId}/components/{componentId}/processes/{processId} - - -### GET - -<a id="get">Get vendor software product process</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>componentId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product component Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>processId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product process Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>version</th> - <td>query</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| 200 | successful operation | <a href="#/definitions/ProcessEntityDto">ProcessEntityDto</a>| - - - - -### PUT - -<a id="update">Update vendor software product process</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - <a href="#/definitions/ProcessRequestDto">ProcessRequestDto</a> - </td> - -</tr> - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>componentId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product component Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>processId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product process Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - -### DELETE - -<a id="delete">Delete vendor software product process</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>componentId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product component Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>processId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product process Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - -## /v1.0/vendor-software-products/{vspId}/components/{componentId}/processes/{processId}/upload - - -### GET - -<a id="getUploadedFile">Get vendor software product process uploaded file</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>componentId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product component Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>processId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product process Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>version</th> - <td>query</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/octet-stream - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - -### POST - - -<a id="uploadFile">Update vendor software product process upload</a> - - - - - - - - - -#### Request - - -**Content-Type: ** multipart/form-data - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - <a href="#/definitions/Attachment">Attachment</a> - </td> - -</tr> - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>componentId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product component Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>processId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product process Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - -### DELETE - -<a id="deleteUploadedFile">Delete vendor software product process uploaded file</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>componentId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product component Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>processId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product process Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - -## /v1.0/vendor-software-products/{vspId}/components/{componentId}/questionnaire - - -### GET - -<a id="getQuestionnaire">Get vendor software product component questionnaire</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>componentId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product component Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>version</th> - <td>query</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| 200 | successful operation | <a href="#/definitions/QuestionnaireResponseDto">QuestionnaireResponseDto</a>| - - - - -### PUT - -<a id="updateQuestionnaire">Update vendor software product component questionnaire</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - - </td> - -</tr> - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>componentId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product component Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - - - - - -## /v1.0/vendor-software-products/{vspId}/downloadHeat - - -### GET - -<a id="getLatestHeatPackage">Get uploaded HEAT file</a> - -Downloads the latest HEAT package - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/octet-stream - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| 200 | successful operation | <a href="#/definitions/File">File</a>| - - - - - - - - - - - - - - - - - -## /v1.0/vendor-software-products/{vspId}/networks - - -### GET - -<a id="list">List vendor software product networks</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>version</th> - <td>query</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| 200 | successful operation | Array[<a href="#/definitions/NetworkDto">NetworkDto</a>]| - - - - - - -### POST - - -<a id="create">Create a vendor software product network</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - <a href="#/definitions/NetworkRequestDto">NetworkRequestDto</a> - </td> - -</tr> - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - - - - -## /v1.0/vendor-software-products/{vspId}/networks/{networkId} - - -### GET - -<a id="get">Get vendor software product network</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>networkId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product network Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>version</th> - <td>query</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| 200 | successful operation | <a href="#/definitions/NetworkDto">NetworkDto</a>| - - - - -### PUT - -<a id="update">Update vendor software product network</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - <a href="#/definitions/NetworkRequestDto">NetworkRequestDto</a> - </td> - -</tr> - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>networkId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product network Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - -### DELETE - -<a id="delete">Delete vendor software product network</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>networkId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product network Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - -## /v1.0/vendor-software-products/{vspId}/processes - - -### GET - -<a id="list">List vendor software product processes</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>version</th> - <td>query</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| 200 | successful operation | Array[<a href="#/definitions/ProcessEntityDto">ProcessEntityDto</a>]| - - - - - - -### POST - - -<a id="create">Create a vendor software product process</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - <a href="#/definitions/ProcessRequestDto">ProcessRequestDto</a> - </td> - -</tr> - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - -### DELETE - -<a id="deleteList">Delete vendor software product processes</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - -## /v1.0/vendor-software-products/{vspId}/processes/{processId} - - -### GET - -<a id="get">Get vendor software product process</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>processId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product process Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>version</th> - <td>query</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| 200 | successful operation | <a href="#/definitions/ProcessEntityDto">ProcessEntityDto</a>| - - - - -### PUT - -<a id="update">Update vendor software product process</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - <a href="#/definitions/ProcessRequestDto">ProcessRequestDto</a> - </td> - -</tr> - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>processId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product process Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - -### DELETE - -<a id="delete">Delete vendor software product process</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>processId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product process Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - -## /v1.0/vendor-software-products/{vspId}/processes/{processId}/upload - - -### GET - -<a id="getUploadedFile">Get vendor software product process uploaded file</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>processId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product process Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>version</th> - <td>query</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/octet-stream - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - -### POST - - -<a id="uploadFile">Update vendor software product process upload</a> - - - - - - - - - -#### Request - - -**Content-Type: ** multipart/form-data - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - <a href="#/definitions/Attachment">Attachment</a> - </td> - -</tr> - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>processId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product process Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - -### DELETE - -<a id="deleteUploadedFile">Delete vendor software product process uploaded file</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>processId</th> - <td>path</td> - <td>yes</td> - <td>Vendor software product process Id</td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - -## /v1.0/vendor-software-products/{vspId}/questionnaire - - -### GET - -<a id="getQuestionnaire">Get vendor software product questionnaire</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>version</th> - <td>query</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| 200 | successful operation | <a href="#/definitions/QuestionnaireResponseDto">QuestionnaireResponseDto</a>| - - - - -### PUT - -<a id="updateQuestionnaire">Update vendor software product questionnaire</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - - </td> - -</tr> - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - - - - - -## /v1.0/vendor-software-products/{vspId}/upload - - - - - - -### POST - - -<a id="uploadFile">Uploads a HEAT package to translate</a> - - - - - - - - - -#### Request - - -**Content-Type: ** multipart/form-data - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vspId</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - <a href="#/definitions/InputStream">InputStream</a> - </td> - -</tr> - -<tr> - <th>USER_ID</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| 200 | successful operation | <a href="#/definitions/UploadFileResponseDto">UploadFileResponseDto</a>| - - - - - - - - - - - - - - -## /workflow/v1.0/actions - - -### GET - -<a id="getFilteredActions">List Filtered Actions </a> - -Get list of actions based on a filter criteria | If no filter is sent all actions will be returned - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>vendor</th> - <td>query</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>category</th> - <td>query</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>name</th> - <td>query</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>modelId</th> - <td>query</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>componentId</th> - <td>query</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - -### POST - - -<a id="createAction">Create a new Action</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - - </td> - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - - - - -## /workflow/v1.0/actions/components - - -### GET - -<a id="getEcompComponents">List ECOMP Components supported by Action Library</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - - - - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - - - - - - - -## /workflow/v1.0/actions/{actionInvariantUUID} - - -### GET - -<a id="getActionsByActionInvariantUuId">List Actions For Given Action Invariant UUID</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>actionInvariantUUID</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>version</th> - <td>query</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - -### PUT - -<a id="updateAction">Update an existing action</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>actionInvariantUUID</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - - </td> - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - -### POST - - -<a id="actOnAction">Actions on a action</a> - -Performs one of the following actions on a action: |Checkout: Locks it for edits by other users. Only the locking user sees the edited version.|Undo_Checkout: Unlocks it and deletes the edits that were done.|Checkin: Unlocks it and activates the edited version to all users.| Submit: Finalize its active version.| - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>actionInvariantUUID</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - - </td> - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - -### DELETE - -<a id="deleteAction">Delete Action</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>actionInvariantUUID</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - -## /workflow/v1.0/actions/{actionInvariantUUID}/artifacts - - - - - - -### POST - - -<a id="uploadArtifact">Upload new Artifact</a> - - - - - - - - - -#### Request - - -**Content-Type: ** multipart/form-data - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>actionInvariantUUID</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - - </td> - -</tr> - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - - </td> - -</tr> - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - - </td> - -</tr> - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - - </td> - -</tr> - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - - </td> - -</tr> - -<tr> - <th>Content-MD5</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - <a href="#/definitions/Attachment">Attachment</a> - </td> - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - - - - -## /workflow/v1.0/actions/{actionInvariantUUID}/artifacts/{artifactUUID} - - - - -### PUT - -<a id="updateArtifact">Update an existing artifact</a> - - - - - - - - - -#### Request - - -**Content-Type: ** multipart/form-data - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>actionInvariantUUID</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>artifactUUID</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - - </td> - -</tr> - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - - </td> - -</tr> - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - - </td> - -</tr> - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - - </td> - -</tr> - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - - </td> - -</tr> - -<tr> - <th>Content-MD5</th> - <td>header</td> - <td>no</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>body</th> - <td>body</td> - <td>no</td> - <td></td> - <td> - </td> - - <td> - - <a href="#/definitions/Attachment">Attachment</a> - </td> - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - -### DELETE - -<a id="deleteArtifact">Delete Artifact</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>actionInvariantUUID</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>artifactUUID</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/json - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - -## /workflow/v1.0/actions/{actionUUID}/artifacts/{artifactUUID} - - -### GET - -<a id="downloadArtifact">Downloads artifact for action</a> - - - - - - - - - -#### Request - - -**Content-Type: ** application/json - -##### Parameters - -<table border="1"> - <tr> - <th>Name</th> - <th>Located in</th> - <th>Required</th> - <th>Description</th> - <th>Default</th> - <th>Schema</th> - </tr> - - - -<tr> - <th>actionUUID</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - -<tr> - <th>artifactUUID</th> - <td>path</td> - <td>yes</td> - <td></td> - <td> - </td> - - - <td>string </td> - - -</tr> - - -</table> - - - -#### Response - -**Content-Type: ** application/octet-stream - - -| Status Code | Reason | Response Model | -|-------------|-------------|----------------| -| default | successful operation | - | - - - - - - - - - - - - - - - - - - -# Definitions - -## <a name="/definitions/Attachment">Attachment</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>headers</td> - <td> - - - object - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>object</td> - <td> - - - object - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>contentType</td> - <td> - - <a href="#/definitions/MediaType">MediaType</a> - - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>contentDisposition</td> - <td> - - <a href="#/definitions/ContentDisposition">ContentDisposition</a> - - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>dataHandler</td> - <td> - - <a href="#/definitions/DataHandler">DataHandler</a> - - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>contentId</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/ChoiceOrOtherDtoAggregationFunction">ChoiceOrOtherDtoAggregationFunction</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>choice</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>other</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/ChoiceOrOtherDtoEntitlementMetric">ChoiceOrOtherDtoEntitlementMetric</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>choice</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>other</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/ChoiceOrOtherDtoEntitlementTime">ChoiceOrOtherDtoEntitlementTime</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>choice</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>other</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/ChoiceOrOtherDtoLicenseTerm">ChoiceOrOtherDtoLicenseTerm</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>choice</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>other</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/CommandInfo">CommandInfo</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>commandClass</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>commandName</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/ComponentData">ComponentData</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>name</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>description</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>displayName</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/ComponentDto">ComponentDto</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>name</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>displayName</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>description</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>id</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/ComponentRequestDto">ComponentRequestDto</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>name</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>displayName</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>description</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/ConfigurationDataDto">ConfigurationDataDto</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>value</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>timeStamp</td> - <td> - - - integer (int64) - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/ContentDisposition">ContentDisposition</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>type</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>parameters</td> - <td> - - - object - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>filename</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/DataFlavor">DataFlavor</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>mimeType</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>humanPresentableName</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>defaultRepresentationClassAsString</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>primaryType</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>flavorJavaFileListType</td> - <td> - - - boolean - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>flavorRemoteObjectType</td> - <td> - - - boolean - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>flavorSerializedObjectType</td> - <td> - - - boolean - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>flavorTextType</td> - <td> - - - boolean - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>mimeTypeSerializedObject</td> - <td> - - - boolean - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>representationClassByteBuffer</td> - <td> - - - boolean - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>representationClassCharBuffer</td> - <td> - - - boolean - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>representationClassInputStream</td> - <td> - - - boolean - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>representationClassReader</td> - <td> - - - boolean - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>representationClassRemote</td> - <td> - - - boolean - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>representationClassSerializable</td> - <td> - - - boolean - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>subType</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/DataHandler">DataHandler</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>dataSource</td> - <td> - - <a href="#/definitions/DataSource">DataSource</a> - - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>name</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>inputStream</td> - <td> - - <a href="#/definitions/InputStream">InputStream</a> - - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>content</td> - <td> - - - object - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>contentType</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>outputStream</td> - <td> - - <a href="#/definitions/OutputStream">OutputStream</a> - - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>allCommands</td> - <td> - - - array[<a href="#/definitions/CommandInfo">CommandInfo</a>] - - - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>preferredCommands</td> - <td> - - - array[<a href="#/definitions/CommandInfo">CommandInfo</a>] - - - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>transferDataFlavors</td> - <td> - - - array[<a href="#/definitions/DataFlavor">DataFlavor</a>] - - - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/DataSource">DataSource</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>name</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>inputStream</td> - <td> - - <a href="#/definitions/InputStream">InputStream</a> - - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>contentType</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>outputStream</td> - <td> - - <a href="#/definitions/OutputStream">OutputStream</a> - - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/EntitlementPoolEntity">EntitlementPoolEntity</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>name</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>description</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>thresholdValue</td> - <td> - - - integer (int32) - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>thresholdUnits</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>entitlementMetric</td> - <td> - - <a href="#/definitions/ChoiceOrOtherDtoEntitlementMetric">ChoiceOrOtherDtoEntitlementMetric</a> - - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>increments</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>aggregationFunction</td> - <td> - - <a href="#/definitions/ChoiceOrOtherDtoAggregationFunction">ChoiceOrOtherDtoAggregationFunction</a> - - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>operationalScope</td> - <td> - - <a href="#/definitions/MultiChoiceOrOtherDtoOperationalScope">MultiChoiceOrOtherDtoOperationalScope</a> - - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>time</td> - <td> - - <a href="#/definitions/ChoiceOrOtherDtoEntitlementTime">ChoiceOrOtherDtoEntitlementTime</a> - - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>manufacturerReferenceNumber</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>id</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>referencingFeatureGroups</td> - <td> - - - array[string] - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/EntitlementPoolRequest">EntitlementPoolRequest</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>name</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>description</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>thresholdValue</td> - <td> - - - integer (int32) - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>thresholdUnits</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>entitlementMetric</td> - <td> - - <a href="#/definitions/ChoiceOrOtherDtoEntitlementMetric">ChoiceOrOtherDtoEntitlementMetric</a> - - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>increments</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>aggregationFunction</td> - <td> - - <a href="#/definitions/ChoiceOrOtherDtoAggregationFunction">ChoiceOrOtherDtoAggregationFunction</a> - - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>operationalScope</td> - <td> - - <a href="#/definitions/MultiChoiceOrOtherDtoOperationalScope">MultiChoiceOrOtherDtoOperationalScope</a> - - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>time</td> - <td> - - <a href="#/definitions/ChoiceOrOtherDtoEntitlementTime">ChoiceOrOtherDtoEntitlementTime</a> - - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>manufacturerReferenceNumber</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/ErrorMessage">ErrorMessage</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>level</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>message</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/FeatureGroupEntity">FeatureGroupEntity</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>name</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>description</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>partNumber</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>id</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>licenseKeyGroupsIds</td> - <td> - - - array[string] - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>entitlementPoolsIds</td> - <td> - - - array[string] - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>referencingLicenseAgreements</td> - <td> - - - array[string] - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/FeatureGroupModel">FeatureGroupModel</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>name</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>description</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>partNumber</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>id</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>referencingLicenseAgreements</td> - <td> - - - array[string] - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>licenseKeyGroups</td> - <td> - - - array[<a href="#/definitions/LicenseKeyGroupEntityDto">LicenseKeyGroupEntityDto</a>] - - - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>entitlementPools</td> - <td> - - - array[<a href="#/definitions/EntitlementPoolEntity">EntitlementPoolEntity</a>] - - - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/FeatureGroupRequest">FeatureGroupRequest</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>name</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>description</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>partNumber</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>addedLicenseKeyGroupsIds</td> - <td> - - - array[string] - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>addedEntitlementPoolsIds</td> - <td> - - - array[string] - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/FeatureGroupUpdateRequest">FeatureGroupUpdateRequest</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>name</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>description</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>partNumber</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>addedLicenseKeyGroupsIds</td> - <td> - - - array[string] - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>addedEntitlementPoolsIds</td> - <td> - - - array[string] - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>removedLicenseKeyGroupsIds</td> - <td> - - - array[string] - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>removedEntitlementPoolsIds</td> - <td> - - - array[string] - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/File">File</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>path</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>name</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>canonicalPath</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>parent</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>absolute</td> - <td> - - - boolean - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>absoluteFile</td> - <td> - - <a href="#/definitions/File">File</a> - - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>absolutePath</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>canonicalFile</td> - <td> - - <a href="#/definitions/File">File</a> - - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>freeSpace</td> - <td> - - - integer (int64) - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>parentFile</td> - <td> - - <a href="#/definitions/File">File</a> - - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>totalSpace</td> - <td> - - - integer (int64) - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>usableSpace</td> - <td> - - - integer (int64) - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>directory</td> - <td> - - - boolean - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>file</td> - <td> - - - boolean - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>hidden</td> - <td> - - - boolean - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/InputStream">InputStream</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - -</table> - -## <a name="/definitions/LicenseAgreementEntity">LicenseAgreementEntity</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>name</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>description</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>licenseTerm</td> - <td> - - <a href="#/definitions/ChoiceOrOtherDtoLicenseTerm">ChoiceOrOtherDtoLicenseTerm</a> - - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>requirementsAndConstrains</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>id</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>featureGroupsIds</td> - <td> - - - array[string] - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/LicenseAgreementModel">LicenseAgreementModel</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>name</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>description</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>licenseTerm</td> - <td> - - <a href="#/definitions/ChoiceOrOtherDtoLicenseTerm">ChoiceOrOtherDtoLicenseTerm</a> - - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>requirementsAndConstrains</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>id</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>featureGroups</td> - <td> - - - array[<a href="#/definitions/FeatureGroupEntity">FeatureGroupEntity</a>] - - - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/LicenseAgreementRequest">LicenseAgreementRequest</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>name</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>description</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>licenseTerm</td> - <td> - - <a href="#/definitions/ChoiceOrOtherDtoLicenseTerm">ChoiceOrOtherDtoLicenseTerm</a> - - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>requirementsAndConstrains</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>addedFeatureGroupsIds</td> - <td> - - - array[string] - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/LicenseAgreementUpdateRequest">LicenseAgreementUpdateRequest</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>name</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>description</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>licenseTerm</td> - <td> - - <a href="#/definitions/ChoiceOrOtherDtoLicenseTerm">ChoiceOrOtherDtoLicenseTerm</a> - - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>requirementsAndConstrains</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>addedFeatureGroupsIds</td> - <td> - - - array[string] - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>removedFeatureGroupsIds</td> - <td> - - - array[string] - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/LicenseKeyGroupEntityDto">LicenseKeyGroupEntityDto</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>name</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>description</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>type</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>operationalScope</td> - <td> - - <a href="#/definitions/MultiChoiceOrOtherDtoOperationalScope">MultiChoiceOrOtherDtoOperationalScope</a> - - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>id</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>referencingFeatureGroups</td> - <td> - - - array[string] - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/LicenseKeyGroupRequestDto">LicenseKeyGroupRequestDto</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>name</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>description</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>type</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>operationalScope</td> - <td> - - <a href="#/definitions/MultiChoiceOrOtherDtoOperationalScope">MultiChoiceOrOtherDtoOperationalScope</a> - - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/LicensingData">LicensingData</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>licenseAgreement</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>featureGroups</td> - <td> - - - array[string] - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/MediaType">MediaType</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>type</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>subtype</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>parameters</td> - <td> - - - object - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>wildcardType</td> - <td> - - - boolean - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>wildcardSubtype</td> - <td> - - - boolean - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/MibUploadStatusDto">MibUploadStatusDto</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>snmpTrap</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>snmpPoll</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/MultiChoiceOrOtherDtoOperationalScope">MultiChoiceOrOtherDtoOperationalScope</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>choices</td> - <td> - - - array[string] - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>other</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/NetworkDto">NetworkDto</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>name</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>dhcp</td> - <td> - - - boolean - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>id</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/NetworkRequestDto">NetworkRequestDto</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>name</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>dhcp</td> - <td> - - - boolean - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/NicDto">NicDto</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>name</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>description</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>networkId</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>id</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>networkName</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/NicRequestDto">NicRequestDto</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>name</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>description</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>networkId</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/OutputStream">OutputStream</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - -</table> - -## <a name="/definitions/PackageInfoDto">PackageInfoDto</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>displayName</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>description</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>vspName</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>version</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>packageId</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>category</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>subCategory</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>vendorName</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>vendorRelease</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>packageChecksum</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>packageType</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/ProcessEntityDto">ProcessEntityDto</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>name</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>description</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>id</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>artifactName</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/ProcessRequestDto">ProcessRequestDto</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>name</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>description</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/QuestionnaireResponseDto">QuestionnaireResponseDto</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>schema</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>data</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/UploadFileResponseDto">UploadFileResponseDto</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>fileNames</td> - <td> - - - array[string] - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>errors</td> - <td> - - - object - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>status</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/VendorLicenseModelActionRequestDto">VendorLicenseModelActionRequestDto</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>action</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/VendorLicenseModelEntity">VendorLicenseModelEntity</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>vendorName</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>description</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>iconRef</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>id</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>version</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>status</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>lockingUser</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>viewableVersions</td> - <td> - - - array[string] - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>finalVersions</td> - <td> - - - array[string] - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/VendorLicenseModelRequest">VendorLicenseModelRequest</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>vendorName</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>description</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>iconRef</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/VersionSoftwareProductActionRequestDto">VersionSoftwareProductActionRequestDto</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>action</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/VspCreationDto">VspCreationDto</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>vspId</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - -## <a name="/definitions/VspDescriptionDto">VspDescriptionDto</a> - -<table border="1"> - <tr> - <th>name</th> - <th>type</th> - <th>required</th> - <th>description</th> - <th>example</th> - </tr> - - <tr> - <td>name</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>description</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>icon</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>category</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>subCategory</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>vendorName</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>vendorId</td> - <td> - - - string - - </td> - <td>required</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>licensingVersion</td> - <td> - - - string - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - - <tr> - <td>licensingData</td> - <td> - - <a href="#/definitions/LicensingData">LicensingData</a> - - - </td> - <td>optional</td> - <td>-</td> - <td></td> - </tr> - -</table> - - - - - \ No newline at end of file diff --git a/openecomp-be/tools/swagger-ui/api-docs/api.json b/openecomp-be/tools/swagger-ui/api-docs/api.json deleted file mode 100644 index efcb5e84ab..0000000000 --- a/openecomp-be/tools/swagger-ui/api-docs/api.json +++ /dev/null @@ -1,4676 +0,0 @@ -{ - "swagger" : "2.0", - "info" : { - "description" : "Rest API Documentation", - "version" : "v1.0, build #${buildNumber}", - "title" : "Rest API", - "termsOfService" : "http://www.github.com/kongchen/swagger-maven-plugin" - }, - "basePath" : "/onboarding-api", - "tags" : [ { - "name" : "Vendor Software Product Component NICs" - }, { - "name" : "Vendor Software Product Component Processes" - }, { - "name" : "Vendor Software Product Component MIB Uploads" - }, { - "name" : "Vendor License Model - License Key Groups" - }, { - "name" : "Application Configuration" - }, { - "name" : "Vendor License Model - License Agreements" - }, { - "name" : "Vendor License Model - Feature Groups" - }, { - "name" : "Vendor Software Product Processes" - }, { - "name" : "Actions" - }, { - "name" : "Validation" - }, { - "name" : "Vendor Software Product Components" - }, { - "name" : "Vendor Software Products" - }, { - "name" : "Vendor Software Product Networks" - }, { - "name" : "Vendor License Model - Entitlement Pools" - }, { - "name" : "Vendor License Models" - } ], - "schemes" : [ "http" ], - "paths" : { - "/v1.0/application-configuration" : { - "post" : { - "tags" : [ "Application Configuration" ], - "summary" : "Insert JSON schema into application config table", - "description" : "", - "operationId" : "insertToTable", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "namespace", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "key", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/InputStream" - } - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/v1.0/application-configuration/{namespace}" : { - "get" : { - "tags" : [ "Application Configuration" ], - "summary" : "Get List of keys and values by namespace", - "description" : "", - "operationId" : "getListOfConfigurationByNamespaceFromTable", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "namespace", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/v1.0/application-configuration/{namespace}/{key}" : { - "get" : { - "tags" : [ "Application Configuration" ], - "summary" : "Get JSON schema by namespace and key", - "description" : "", - "operationId" : "getFromTable", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "namespace", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "key", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ConfigurationDataDto" - } - } - } - } - }, - "/v1.0/validation/{type}/validate" : { - "post" : { - "tags" : [ "Validation" ], - "summary" : "Validate a package", - "description" : "", - "operationId" : "validateFile", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "type", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/InputStream" - } - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/v1.0/vendor-license-models" : { - "get" : { - "tags" : [ "Vendor License Models" ], - "summary" : "List vendor license models", - "description" : "", - "operationId" : "listLicenseModels", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "versionFilter", - "in" : "query", - "description" : "Currently supported value: 'Final' - only vendor License models with final versions will be return - with their latest final version", - "required" : false, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/VendorLicenseModelEntity" - } - } - } - } - }, - "post" : { - "tags" : [ "Vendor License Models" ], - "summary" : "Create vendor license model", - "description" : "", - "operationId" : "createLicenseModel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/VendorLicenseModelRequest" - } - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/v1.0/vendor-license-models/{vlmId}" : { - "get" : { - "tags" : [ "Vendor License Models" ], - "summary" : "Get vendor license model", - "description" : "", - "operationId" : "getLicenseModel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vlmId", - "in" : "path", - "description" : "Vendor license model Id", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VendorLicenseModelEntity" - } - } - } - }, - "put" : { - "tags" : [ "Vendor License Models" ], - "summary" : "Update vendor license model", - "description" : "", - "operationId" : "updateLicenseModel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/VendorLicenseModelRequest" - } - }, { - "name" : "vlmId", - "in" : "path", - "description" : "Vendor license model Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - }, - "delete" : { - "tags" : [ "Vendor License Models" ], - "summary" : "Delete vendor license model", - "description" : "", - "operationId" : "deleteLicenseModel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vlmId", - "in" : "path", - "description" : "Vendor license model Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/v1.0/vendor-license-models/{vlmId}/actions" : { - "put" : { - "tags" : [ "Vendor License Models" ], - "summary" : "Update vendor license model", - "description" : "", - "operationId" : "actOnLicenseModel", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/VendorLicenseModelActionRequestDto" - } - }, { - "name" : "vlmId", - "in" : "path", - "description" : "Vendor license model Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/v1.0/vendor-license-models/{vlmId}/entitlement-pools" : { - "get" : { - "tags" : [ "Vendor License Model - Entitlement Pools" ], - "summary" : "List vendor entitlement pools", - "description" : "", - "operationId" : "listEntitlementPools", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vlmId", - "in" : "path", - "description" : "Vendor license model Id", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/EntitlementPoolEntity" - } - } - } - } - }, - "post" : { - "tags" : [ "Vendor License Model - Entitlement Pools" ], - "summary" : "Create vendor entitlement pool", - "description" : "", - "operationId" : "createEntitlementPool", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/EntitlementPoolRequest" - } - }, { - "name" : "vlmId", - "in" : "path", - "description" : "Vendor license model Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/v1.0/vendor-license-models/{vlmId}/entitlement-pools/{entitlementPoolId}" : { - "get" : { - "tags" : [ "Vendor License Model - Entitlement Pools" ], - "summary" : "Get vendor entitlement pool", - "description" : "", - "operationId" : "getEntitlementPool", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vlmId", - "in" : "path", - "description" : "Vendor license model Id", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "entitlementPoolId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/EntitlementPoolEntity" - } - } - } - }, - "put" : { - "tags" : [ "Vendor License Model - Entitlement Pools" ], - "summary" : "Update vendor entitlement pool", - "description" : "", - "operationId" : "updateEntitlementPool", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/EntitlementPoolRequest" - } - }, { - "name" : "vlmId", - "in" : "path", - "description" : "Vendor license model Id", - "required" : true, - "type" : "string" - }, { - "name" : "entitlementPoolId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - }, - "delete" : { - "tags" : [ "Vendor License Model - Entitlement Pools" ], - "summary" : "Delete vendor entitlement pool", - "description" : "", - "operationId" : "deleteEntitlementPool", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vlmId", - "in" : "path", - "description" : "Vendor license model Id", - "required" : true, - "type" : "string" - }, { - "name" : "entitlementPoolId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/v1.0/vendor-license-models/{vlmId}/feature-groups" : { - "get" : { - "tags" : [ "Vendor License Model - Feature Groups" ], - "summary" : "List vendor feature groups", - "description" : "", - "operationId" : "listFeatureGroups", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vlmId", - "in" : "path", - "description" : "Vendor license model Id", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/FeatureGroupEntity" - } - } - } - } - }, - "post" : { - "tags" : [ "Vendor License Model - Feature Groups" ], - "summary" : "Create vendor feature group", - "description" : "", - "operationId" : "createFeatureGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/FeatureGroupRequest" - } - }, { - "name" : "vlmId", - "in" : "path", - "description" : "Vendor license model Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/v1.0/vendor-license-models/{vlmId}/feature-groups/{featureGroupId}" : { - "get" : { - "tags" : [ "Vendor License Model - Feature Groups" ], - "summary" : "Get vendor feature group", - "description" : "", - "operationId" : "getFeatureGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vlmId", - "in" : "path", - "description" : "Vendor license model Id", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "featureGroupId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/FeatureGroupModel" - } - } - } - }, - "put" : { - "tags" : [ "Vendor License Model - Feature Groups" ], - "summary" : "Update vendor feature group", - "description" : "", - "operationId" : "updateFeatureGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/FeatureGroupUpdateRequest" - } - }, { - "name" : "vlmId", - "in" : "path", - "description" : "Vendor license model Id", - "required" : true, - "type" : "string" - }, { - "name" : "featureGroupId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - }, - "delete" : { - "tags" : [ "Vendor License Model - Feature Groups" ], - "summary" : "Delete vendor feature group", - "description" : "", - "operationId" : "deleteFeatureGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vlmId", - "in" : "path", - "description" : "Vendor license model Id", - "required" : true, - "type" : "string" - }, { - "name" : "featureGroupId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/v1.0/vendor-license-models/{vlmId}/license-agreements" : { - "get" : { - "tags" : [ "Vendor License Model - License Agreements" ], - "summary" : "List vendor license agreements", - "description" : "", - "operationId" : "listLicenseAgreements", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vlmId", - "in" : "path", - "description" : "Vendor license model Id", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/LicenseAgreementEntity" - } - } - } - } - }, - "post" : { - "tags" : [ "Vendor License Model - License Agreements" ], - "summary" : "Create vendor license agreement", - "description" : "", - "operationId" : "createLicenseAgreement", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/LicenseAgreementRequest" - } - }, { - "name" : "vlmId", - "in" : "path", - "description" : "Vendor license model Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/v1.0/vendor-license-models/{vlmId}/license-agreements/{licenseAgreementId}" : { - "get" : { - "tags" : [ "Vendor License Model - License Agreements" ], - "summary" : "Get vendor license agreement", - "description" : "", - "operationId" : "getLicenseAgreement", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vlmId", - "in" : "path", - "description" : "Vendor license model Id", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "licenseAgreementId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LicenseAgreementModel" - } - } - } - }, - "put" : { - "tags" : [ "Vendor License Model - License Agreements" ], - "summary" : "Update vendor license agreement", - "description" : "", - "operationId" : "updateLicenseAgreement", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/LicenseAgreementUpdateRequest" - } - }, { - "name" : "vlmId", - "in" : "path", - "description" : "Vendor license model Id", - "required" : true, - "type" : "string" - }, { - "name" : "licenseAgreementId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - }, - "delete" : { - "tags" : [ "Vendor License Model - License Agreements" ], - "summary" : "Delete vendor license agreement", - "description" : "", - "operationId" : "deleteLicenseAgreement", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vlmId", - "in" : "path", - "description" : "Vendor license model Id", - "required" : true, - "type" : "string" - }, { - "name" : "licenseAgreementId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/v1.0/vendor-license-models/{vlmId}/license-key-groups" : { - "get" : { - "tags" : [ "Vendor License Model - License Key Groups" ], - "summary" : "List vendor license key groups", - "description" : "", - "operationId" : "listLicenseKeyGroups", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vlmId", - "in" : "path", - "description" : "Vendor license model Id", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/LicenseKeyGroupEntityDto" - } - } - } - } - }, - "post" : { - "tags" : [ "Vendor License Model - License Key Groups" ], - "summary" : "Create vendor license key group", - "description" : "", - "operationId" : "createLicenseKeyGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/LicenseKeyGroupRequestDto" - } - }, { - "name" : "vlmId", - "in" : "path", - "description" : "Vendor license model Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/v1.0/vendor-license-models/{vlmId}/license-key-groups/{licenseKeyGroupId}" : { - "get" : { - "tags" : [ "Vendor License Model - License Key Groups" ], - "summary" : "Get vendor license key group", - "description" : "", - "operationId" : "getLicenseKeyGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vlmId", - "in" : "path", - "description" : "Vendor license model Id", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "licenseKeyGroupId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/LicenseKeyGroupEntityDto" - } - } - } - }, - "put" : { - "tags" : [ "Vendor License Model - License Key Groups" ], - "summary" : "Update vendor license key group", - "description" : "", - "operationId" : "updateLicenseKeyGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/LicenseKeyGroupRequestDto" - } - }, { - "name" : "vlmId", - "in" : "path", - "description" : "Vendor license model Id", - "required" : true, - "type" : "string" - }, { - "name" : "licenseKeyGroupId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - }, - "delete" : { - "tags" : [ "Vendor License Model - License Key Groups" ], - "summary" : "Delete vendor license key group", - "description" : "", - "operationId" : "deleteLicenseKeyGroup", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vlmId", - "in" : "path", - "description" : "Vendor license model Id", - "required" : true, - "type" : "string" - }, { - "name" : "licenseKeyGroupId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/v1.0/vendor-software-products" : { - "get" : { - "tags" : [ "Vendor Software Products" ], - "summary" : "Get list of vendor software products and their description", - "description" : "", - "operationId" : "getVspList", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "versionFilter", - "in" : "query", - "description" : "Currently supported values: 'Final' - only vendor software products with final version will be return - with their latest final version", - "required" : false, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - }, - "post" : { - "tags" : [ "Vendor Software Products" ], - "summary" : "Create a new vendor software product", - "description" : "", - "operationId" : "createNewVsp", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/VspDescriptionDto" - } - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/VspCreationDto" - } - } - } - } - }, - "/v1.0/vendor-software-products/packages" : { - "get" : { - "tags" : [ "Vendor Software Products" ], - "summary" : "Get list of translated CSAR files details", - "description" : "", - "operationId" : "listPackages", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "category", - "in" : "query", - "description" : "Category", - "required" : false, - "type" : "string" - }, { - "name" : "subCategory", - "in" : "query", - "description" : "Sub-category", - "required" : false, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/PackageInfoDto" - } - } - } - } - } - }, - "/v1.0/vendor-software-products/packages/{vspId}" : { - "get" : { - "tags" : [ "Vendor Software Products" ], - "summary" : "Get translated CSAR file", - "description" : "Exports translated file to a zip file", - "operationId" : "getTranslatedFile", - "consumes" : [ "application/json" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "vspId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/File" - } - } - } - } - }, - "/v1.0/vendor-software-products/{vspId}" : { - "get" : { - "tags" : [ "Vendor Software Products" ], - "summary" : "Get details of a vendor software product", - "description" : "", - "operationId" : "getVspDetails", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vspId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - }, - "put" : { - "tags" : [ "Vendor Software Products" ], - "summary" : "Update an existing vendor software product", - "description" : "", - "operationId" : "updateVsp", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vspId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/VspDescriptionDto" - } - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - }, - "delete" : { - "tags" : [ "Vendor Software Products" ], - "summary" : "Deletes vendor software product by given id", - "description" : "", - "operationId" : "deleteVsp", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vspId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/v1.0/vendor-software-products/{vspId}/actions" : { - "put" : { - "tags" : [ "Vendor Software Products" ], - "summary" : "Actions on a vendor software product", - "description" : "Performs one of the following actions on a vendor software product: |Checkout: Locks it for edits by other users. Only the locking user sees the edited version.|Undo_Checkout: Unlocks it and deletes the edits that were done.|Checkin: Unlocks it and activates the edited version to all users.| Submit: Finalize its active version.|Create_Package: Creates a CSAR zip file.|", - "operationId" : "actOnVendorSoftwareProduct", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vspId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/VersionSoftwareProductActionRequestDto" - } - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/v1.0/vendor-software-products/{vspId}/components" : { - "get" : { - "tags" : [ "Vendor Software Product Components" ], - "summary" : "List vendor software product components", - "description" : "", - "operationId" : "list", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ComponentDto" - } - } - } - } - }, - "post" : { - "tags" : [ "Vendor Software Product Components" ], - "summary" : "Create a vendor software product component", - "description" : "", - "operationId" : "create", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/ComponentRequestDto" - } - }, { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - }, - "delete" : { - "tags" : [ "Vendor Software Product Components" ], - "summary" : "Delete vendor software product components", - "description" : "", - "operationId" : "deleteList", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/v1.0/vendor-software-products/{vspId}/components/{componentId}" : { - "get" : { - "tags" : [ "Vendor Software Product Components" ], - "summary" : "Get vendor software product component", - "description" : "", - "operationId" : "get", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "componentId", - "in" : "path", - "description" : "Vendor software product component Id", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ComponentData" - } - } - } - }, - "put" : { - "tags" : [ "Vendor Software Product Components" ], - "summary" : "Update vendor software product component", - "description" : "", - "operationId" : "update", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/ComponentRequestDto" - } - }, { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "componentId", - "in" : "path", - "description" : "Vendor software product component Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - }, - "delete" : { - "tags" : [ "Vendor Software Product Components" ], - "summary" : "Delete vendor software product component", - "description" : "", - "operationId" : "delete", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "componentId", - "in" : "path", - "description" : "Vendor software product component Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/v1.0/vendor-software-products/{vspId}/components/{componentId}/monitors/snmp" : { - "get" : { - "tags" : [ "Vendor Software Product Component MIB Uploads" ], - "summary" : "Get the filenames of uploaded MIB definitions", - "description" : "", - "operationId" : "list", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "componentId", - "in" : "path", - "description" : "Vendor software product component Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/MibUploadStatusDto" - } - } - } - }, - "delete" : { - "tags" : [ "Vendor Software Product Component MIB Uploads" ], - "summary" : "Delete vendor software product MIB Poll Definitions file", - "description" : "", - "operationId" : "deletePollMibFile", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "componentId", - "in" : "path", - "description" : "Vendor software product component Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/v1.0/vendor-software-products/{vspId}/components/{componentId}/monitors/snmp-trap" : { - "delete" : { - "tags" : [ "Vendor Software Product Component MIB Uploads" ], - "summary" : "Delete vendor software product MIB Trap Definitions file", - "description" : "", - "operationId" : "deleteTrapMibFile", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "componentId", - "in" : "path", - "description" : "Vendor software product component Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/v1.0/vendor-software-products/{vspId}/components/{componentId}/monitors/snmp-trap/upload" : { - "post" : { - "tags" : [ "Vendor Software Product Component MIB Uploads" ], - "summary" : "Upload vendor software product MIB Trap Definitions file", - "description" : "", - "operationId" : "uploadTrapMibFile", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/Attachment" - } - }, { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "componentId", - "in" : "path", - "description" : "Vendor software product component Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/v1.0/vendor-software-products/{vspId}/components/{componentId}/monitors/snmp/upload" : { - "post" : { - "tags" : [ "Vendor Software Product Component MIB Uploads" ], - "summary" : "Upload vendor software product MIB Poll Definitions file", - "description" : "", - "operationId" : "uploadPollMibFile", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/Attachment" - } - }, { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "componentId", - "in" : "path", - "description" : "Vendor software product component Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/v1.0/vendor-software-products/{vspId}/components/{componentId}/nics" : { - "get" : { - "tags" : [ "Vendor Software Product Component NICs" ], - "summary" : "List vendor software product component NICs", - "description" : "", - "operationId" : "list", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "componentId", - "in" : "path", - "description" : "Vendor software product component Id", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/NicDto" - } - } - } - } - }, - "post" : { - "tags" : [ "Vendor Software Product Component NICs" ], - "summary" : "Create a vendor software product NIC", - "description" : "", - "operationId" : "create", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/NicRequestDto" - } - }, { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "componentId", - "in" : "path", - "description" : "Vendor software product component Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/v1.0/vendor-software-products/{vspId}/components/{componentId}/nics/{nicId}" : { - "get" : { - "tags" : [ "Vendor Software Product Component NICs" ], - "summary" : "Get vendor software product NIC", - "description" : "", - "operationId" : "get", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "componentId", - "in" : "path", - "description" : "Vendor software product component Id", - "required" : true, - "type" : "string" - }, { - "name" : "nicId", - "in" : "path", - "description" : "Vendor software product NIC Id", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NicDto" - } - } - } - }, - "put" : { - "tags" : [ "Vendor Software Product Component NICs" ], - "summary" : "Update vendor software product NIC", - "description" : "", - "operationId" : "update", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/NicRequestDto" - } - }, { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "componentId", - "in" : "path", - "description" : "Vendor software product component Id", - "required" : true, - "type" : "string" - }, { - "name" : "nicId", - "in" : "path", - "description" : "Vendor software product NIC Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - }, - "delete" : { - "tags" : [ "Vendor Software Product Component NICs" ], - "summary" : "Delete vendor software product NIC", - "description" : "", - "operationId" : "delete", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "componentId", - "in" : "path", - "description" : "Vendor software product component Id", - "required" : true, - "type" : "string" - }, { - "name" : "nicId", - "in" : "path", - "description" : "Vendor software product NIC Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/v1.0/vendor-software-products/{vspId}/components/{componentId}/nics/{nicId}/questionnaire" : { - "get" : { - "tags" : [ "Vendor Software Product Component NICs" ], - "summary" : "Get vendor software product component NIC questionnaire", - "description" : "", - "operationId" : "getQuestionnaire", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "componentId", - "in" : "path", - "description" : "Vendor software product component Id", - "required" : true, - "type" : "string" - }, { - "name" : "nicId", - "in" : "path", - "description" : "Vendor software product NIC Id", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/QuestionnaireResponseDto" - } - } - } - }, - "put" : { - "tags" : [ "Vendor Software Product Component NICs" ], - "summary" : "Update vendor software product component NIC questionnaire", - "description" : "", - "operationId" : "updateQuestionnaire", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "type" : "string" - } - }, { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "componentId", - "in" : "path", - "description" : "Vendor software product component Id", - "required" : true, - "type" : "string" - }, { - "name" : "nicId", - "in" : "path", - "description" : "Vendor software product NIC Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/v1.0/vendor-software-products/{vspId}/components/{componentId}/processes" : { - "get" : { - "tags" : [ "Vendor Software Product Component Processes" ], - "summary" : "List vendor software product component processes", - "description" : "", - "operationId" : "list", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "componentId", - "in" : "path", - "description" : "Vendor software product component Id", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ProcessEntityDto" - } - } - } - } - }, - "post" : { - "tags" : [ "Vendor Software Product Component Processes" ], - "summary" : "Create a vendor software product process", - "description" : "", - "operationId" : "create", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/ProcessRequestDto" - } - }, { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "componentId", - "in" : "path", - "description" : "Vendor software product component Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - }, - "delete" : { - "tags" : [ "Vendor Software Product Component Processes" ], - "summary" : "Delete vendor software product processes", - "description" : "", - "operationId" : "deleteList", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "componentId", - "in" : "path", - "description" : "Vendor software product component Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/v1.0/vendor-software-products/{vspId}/components/{componentId}/processes/{processId}" : { - "get" : { - "tags" : [ "Vendor Software Product Component Processes" ], - "summary" : "Get vendor software product process", - "description" : "", - "operationId" : "get", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "componentId", - "in" : "path", - "description" : "Vendor software product component Id", - "required" : true, - "type" : "string" - }, { - "name" : "processId", - "in" : "path", - "description" : "Vendor software product process Id", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessEntityDto" - } - } - } - }, - "put" : { - "tags" : [ "Vendor Software Product Component Processes" ], - "summary" : "Update vendor software product process", - "description" : "", - "operationId" : "update", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/ProcessRequestDto" - } - }, { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "componentId", - "in" : "path", - "description" : "Vendor software product component Id", - "required" : true, - "type" : "string" - }, { - "name" : "processId", - "in" : "path", - "description" : "Vendor software product process Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - }, - "delete" : { - "tags" : [ "Vendor Software Product Component Processes" ], - "summary" : "Delete vendor software product process", - "description" : "", - "operationId" : "delete", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "componentId", - "in" : "path", - "description" : "Vendor software product component Id", - "required" : true, - "type" : "string" - }, { - "name" : "processId", - "in" : "path", - "description" : "Vendor software product process Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/v1.0/vendor-software-products/{vspId}/components/{componentId}/processes/{processId}/upload" : { - "get" : { - "tags" : [ "Vendor Software Product Component Processes" ], - "summary" : "Get vendor software product process uploaded file", - "description" : "", - "operationId" : "getUploadedFile", - "consumes" : [ "application/json" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "componentId", - "in" : "path", - "description" : "Vendor software product component Id", - "required" : true, - "type" : "string" - }, { - "name" : "processId", - "in" : "path", - "description" : "Vendor software product process Id", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - }, - "post" : { - "tags" : [ "Vendor Software Product Component Processes" ], - "summary" : "Update vendor software product process upload", - "description" : "", - "operationId" : "uploadFile", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/Attachment" - } - }, { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "componentId", - "in" : "path", - "description" : "Vendor software product component Id", - "required" : true, - "type" : "string" - }, { - "name" : "processId", - "in" : "path", - "description" : "Vendor software product process Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - }, - "delete" : { - "tags" : [ "Vendor Software Product Component Processes" ], - "summary" : "Delete vendor software product process uploaded file", - "description" : "", - "operationId" : "deleteUploadedFile", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "componentId", - "in" : "path", - "description" : "Vendor software product component Id", - "required" : true, - "type" : "string" - }, { - "name" : "processId", - "in" : "path", - "description" : "Vendor software product process Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/v1.0/vendor-software-products/{vspId}/components/{componentId}/questionnaire" : { - "get" : { - "tags" : [ "Vendor Software Product Components" ], - "summary" : "Get vendor software product component questionnaire", - "description" : "", - "operationId" : "getQuestionnaire", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "componentId", - "in" : "path", - "description" : "Vendor software product component Id", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/QuestionnaireResponseDto" - } - } - } - }, - "put" : { - "tags" : [ "Vendor Software Product Components" ], - "summary" : "Update vendor software product component questionnaire", - "description" : "", - "operationId" : "updateQuestionnaire", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "type" : "string" - } - }, { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "componentId", - "in" : "path", - "description" : "Vendor software product component Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/v1.0/vendor-software-products/{vspId}/downloadHeat" : { - "get" : { - "tags" : [ "Vendor Software Products" ], - "summary" : "Get uploaded HEAT file", - "description" : "Downloads the latest HEAT package", - "operationId" : "getLatestHeatPackage", - "consumes" : [ "application/json" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "vspId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/File" - } - } - } - } - }, - "/v1.0/vendor-software-products/{vspId}/networks" : { - "get" : { - "tags" : [ "Vendor Software Product Networks" ], - "summary" : "List vendor software product networks", - "description" : "", - "operationId" : "list", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/NetworkDto" - } - } - } - } - }, - "post" : { - "tags" : [ "Vendor Software Product Networks" ], - "summary" : "Create a vendor software product network", - "description" : "", - "operationId" : "create", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/NetworkRequestDto" - } - }, { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/v1.0/vendor-software-products/{vspId}/networks/{networkId}" : { - "get" : { - "tags" : [ "Vendor Software Product Networks" ], - "summary" : "Get vendor software product network", - "description" : "", - "operationId" : "get", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "networkId", - "in" : "path", - "description" : "Vendor software product network Id", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/NetworkDto" - } - } - } - }, - "put" : { - "tags" : [ "Vendor Software Product Networks" ], - "summary" : "Update vendor software product network", - "description" : "", - "operationId" : "update", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/NetworkRequestDto" - } - }, { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "networkId", - "in" : "path", - "description" : "Vendor software product network Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - }, - "delete" : { - "tags" : [ "Vendor Software Product Networks" ], - "summary" : "Delete vendor software product network", - "description" : "", - "operationId" : "delete", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "networkId", - "in" : "path", - "description" : "Vendor software product network Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/v1.0/vendor-software-products/{vspId}/processes" : { - "get" : { - "tags" : [ "Vendor Software Product Processes" ], - "summary" : "List vendor software product processes", - "description" : "", - "operationId" : "list", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ProcessEntityDto" - } - } - } - } - }, - "post" : { - "tags" : [ "Vendor Software Product Processes" ], - "summary" : "Create a vendor software product process", - "description" : "", - "operationId" : "create", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/ProcessRequestDto" - } - }, { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - }, - "delete" : { - "tags" : [ "Vendor Software Product Processes" ], - "summary" : "Delete vendor software product processes", - "description" : "", - "operationId" : "deleteList", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/v1.0/vendor-software-products/{vspId}/processes/{processId}" : { - "get" : { - "tags" : [ "Vendor Software Product Processes" ], - "summary" : "Get vendor software product process", - "description" : "", - "operationId" : "get", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "processId", - "in" : "path", - "description" : "Vendor software product process Id", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/ProcessEntityDto" - } - } - } - }, - "put" : { - "tags" : [ "Vendor Software Product Processes" ], - "summary" : "Update vendor software product process", - "description" : "", - "operationId" : "update", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/ProcessRequestDto" - } - }, { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "processId", - "in" : "path", - "description" : "Vendor software product process Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - }, - "delete" : { - "tags" : [ "Vendor Software Product Processes" ], - "summary" : "Delete vendor software product process", - "description" : "", - "operationId" : "delete", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "processId", - "in" : "path", - "description" : "Vendor software product process Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/v1.0/vendor-software-products/{vspId}/processes/{processId}/upload" : { - "get" : { - "tags" : [ "Vendor Software Product Processes" ], - "summary" : "Get vendor software product process uploaded file", - "description" : "", - "operationId" : "getUploadedFile", - "consumes" : [ "application/json" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "processId", - "in" : "path", - "description" : "Vendor software product process Id", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - }, - "post" : { - "tags" : [ "Vendor Software Product Processes" ], - "summary" : "Update vendor software product process upload", - "description" : "", - "operationId" : "uploadFile", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/Attachment" - } - }, { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "processId", - "in" : "path", - "description" : "Vendor software product process Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - }, - "delete" : { - "tags" : [ "Vendor Software Product Processes" ], - "summary" : "Delete vendor software product process uploaded file", - "description" : "", - "operationId" : "deleteUploadedFile", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vspId", - "in" : "path", - "description" : "Vendor software product Id", - "required" : true, - "type" : "string" - }, { - "name" : "processId", - "in" : "path", - "description" : "Vendor software product process Id", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/v1.0/vendor-software-products/{vspId}/questionnaire" : { - "get" : { - "tags" : [ "Vendor Software Products" ], - "summary" : "Get vendor software product questionnaire", - "description" : "", - "operationId" : "getQuestionnaire", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vspId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/QuestionnaireResponseDto" - } - } - } - }, - "put" : { - "tags" : [ "Vendor Software Products" ], - "summary" : "Update vendor software product questionnaire", - "description" : "", - "operationId" : "updateQuestionnaire", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "type" : "string" - } - }, { - "name" : "vspId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/v1.0/vendor-software-products/{vspId}/upload" : { - "post" : { - "tags" : [ "Vendor Software Products" ], - "summary" : "Uploads a HEAT package to translate", - "description" : "", - "operationId" : "uploadFile", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vspId", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/InputStream" - } - }, { - "name" : "USER_ID", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - } ], - "responses" : { - "200" : { - "description" : "successful operation", - "schema" : { - "$ref" : "#/definitions/UploadFileResponseDto" - } - } - } - } - }, - "/workflow/v1.0/actions" : { - "get" : { - "tags" : [ "Actions" ], - "summary" : "List Filtered Actions ", - "description" : "Get list of actions based on a filter criteria | If no filter is sent all actions will be returned", - "operationId" : "getFilteredActions", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "vendor", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "category", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "name", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "modelId", - "in" : "query", - "required" : false, - "type" : "string" - }, { - "name" : "componentId", - "in" : "query", - "required" : false, - "type" : "string" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - }, - "post" : { - "tags" : [ "Actions" ], - "summary" : "Create a new Action", - "description" : "", - "operationId" : "createAction", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/workflow/v1.0/actions/components" : { - "get" : { - "tags" : [ "Actions" ], - "summary" : "List ECOMP Components supported by Action Library", - "description" : "", - "operationId" : "getEcompComponents", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/workflow/v1.0/actions/{actionInvariantUUID}" : { - "get" : { - "tags" : [ "Actions" ], - "summary" : "List Actions For Given Action Invariant UUID", - "description" : "", - "operationId" : "getActionsByActionInvariantUuId", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "actionInvariantUUID", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "version", - "in" : "query", - "required" : false, - "type" : "string" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - }, - "post" : { - "tags" : [ "Actions" ], - "summary" : "Actions on a action", - "description" : "Performs one of the following actions on a action: |Checkout: Locks it for edits by other users. Only the locking user sees the edited version.|Undo_Checkout: Unlocks it and deletes the edits that were done.|Checkin: Unlocks it and activates the edited version to all users.| Submit: Finalize its active version.|", - "operationId" : "actOnAction", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "actionInvariantUUID", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - }, - "put" : { - "tags" : [ "Actions" ], - "summary" : "Update an existing action", - "description" : "", - "operationId" : "updateAction", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "actionInvariantUUID", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - }, - "delete" : { - "tags" : [ "Actions" ], - "summary" : "Delete Action", - "description" : "", - "operationId" : "deleteAction", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "actionInvariantUUID", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/workflow/v1.0/actions/{actionInvariantUUID}/artifacts" : { - "post" : { - "tags" : [ "Actions" ], - "summary" : "Upload new Artifact", - "description" : "", - "operationId" : "uploadArtifact", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "actionInvariantUUID", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "type" : "string" - } - }, { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "type" : "string" - } - }, { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "type" : "string" - } - }, { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "type" : "string" - } - }, { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "type" : "string" - } - }, { - "name" : "Content-MD5", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - }, { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/Attachment" - } - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/workflow/v1.0/actions/{actionInvariantUUID}/artifacts/{artifactUUID}" : { - "put" : { - "tags" : [ "Actions" ], - "summary" : "Update an existing artifact", - "description" : "", - "operationId" : "updateArtifact", - "consumes" : [ "multipart/form-data" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "actionInvariantUUID", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "artifactUUID", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "type" : "string" - } - }, { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "type" : "string" - } - }, { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "type" : "string" - } - }, { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "type" : "string" - } - }, { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "type" : "string" - } - }, { - "name" : "Content-MD5", - "in" : "header", - "required" : false, - "type" : "string", - "default" : "" - }, { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/Attachment" - } - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - }, - "delete" : { - "tags" : [ "Actions" ], - "summary" : "Delete Artifact", - "description" : "", - "operationId" : "deleteArtifact", - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "actionInvariantUUID", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "artifactUUID", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - }, - "/workflow/v1.0/actions/{actionUUID}/artifacts/{artifactUUID}" : { - "get" : { - "tags" : [ "Actions" ], - "summary" : "Downloads artifact for action", - "description" : "", - "operationId" : "downloadArtifact", - "consumes" : [ "application/json" ], - "produces" : [ "application/octet-stream" ], - "parameters" : [ { - "name" : "actionUUID", - "in" : "path", - "required" : true, - "type" : "string" - }, { - "name" : "artifactUUID", - "in" : "path", - "required" : true, - "type" : "string" - } ], - "responses" : { - "default" : { - "description" : "successful operation" - } - } - } - } - }, - "definitions" : { - "Attachment" : { - "type" : "object", - "properties" : { - "headers" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "type" : "string" - } - } - }, - "object" : { - "type" : "object" - }, - "contentType" : { - "$ref" : "#/definitions/MediaType" - }, - "contentId" : { - "type" : "string" - }, - "contentDisposition" : { - "$ref" : "#/definitions/ContentDisposition" - }, - "dataHandler" : { - "$ref" : "#/definitions/DataHandler" - } - } - }, - "ChoiceOrOtherDtoAggregationFunction" : { - "type" : "object", - "required" : [ "choice", "other" ], - "properties" : { - "choice" : { - "type" : "string", - "enum" : [ "Peak", "Average", "Other" ] - }, - "other" : { - "type" : "string" - } - } - }, - "ChoiceOrOtherDtoEntitlementMetric" : { - "type" : "object", - "required" : [ "choice", "other" ], - "properties" : { - "choice" : { - "type" : "string", - "enum" : [ "Software_Instances_Count", "Core", "CPU", "Trunks", "User", "Subscribers", "Tenants", "Tokens", "Seats", "Units_TB", "Units_MB", "Units_GB", "Other" ] - }, - "other" : { - "type" : "string" - } - } - }, - "ChoiceOrOtherDtoEntitlementTime" : { - "type" : "object", - "required" : [ "choice", "other" ], - "properties" : { - "choice" : { - "type" : "string", - "enum" : [ "Hour", "Day", "Month", "Quarter", "Year", "Other" ] - }, - "other" : { - "type" : "string" - } - } - }, - "ChoiceOrOtherDtoLicenseTerm" : { - "type" : "object", - "required" : [ "choice", "other" ], - "properties" : { - "choice" : { - "type" : "string", - "enum" : [ "Fixed_Term", "Perpetual", "Unlimited", "Other" ] - }, - "other" : { - "type" : "string" - } - } - }, - "CommandInfo" : { - "type" : "object", - "properties" : { - "commandClass" : { - "type" : "string" - }, - "commandName" : { - "type" : "string" - } - } - }, - "ComponentData" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string" - }, - "description" : { - "type" : "string" - }, - "displayName" : { - "type" : "string" - } - } - }, - "ComponentDto" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string" - }, - "displayName" : { - "type" : "string" - }, - "description" : { - "type" : "string" - }, - "id" : { - "type" : "string" - } - } - }, - "ComponentRequestDto" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string" - }, - "displayName" : { - "type" : "string" - }, - "description" : { - "type" : "string" - } - } - }, - "ConfigurationDataDto" : { - "type" : "object", - "properties" : { - "value" : { - "type" : "string" - }, - "timeStamp" : { - "type" : "integer", - "format" : "int64" - } - } - }, - "ContentDisposition" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string" - }, - "parameters" : { - "type" : "object", - "additionalProperties" : { - "type" : "string" - } - }, - "filename" : { - "type" : "string" - } - } - }, - "DataFlavor" : { - "type" : "object", - "properties" : { - "mimeType" : { - "type" : "string" - }, - "humanPresentableName" : { - "type" : "string" - }, - "subType" : { - "type" : "string" - }, - "defaultRepresentationClassAsString" : { - "type" : "string" - }, - "primaryType" : { - "type" : "string" - }, - "flavorJavaFileListType" : { - "type" : "boolean", - "default" : false - }, - "flavorRemoteObjectType" : { - "type" : "boolean", - "default" : false - }, - "flavorSerializedObjectType" : { - "type" : "boolean", - "default" : false - }, - "flavorTextType" : { - "type" : "boolean", - "default" : false - }, - "mimeTypeSerializedObject" : { - "type" : "boolean", - "default" : false - }, - "representationClassByteBuffer" : { - "type" : "boolean", - "default" : false - }, - "representationClassCharBuffer" : { - "type" : "boolean", - "default" : false - }, - "representationClassInputStream" : { - "type" : "boolean", - "default" : false - }, - "representationClassReader" : { - "type" : "boolean", - "default" : false - }, - "representationClassRemote" : { - "type" : "boolean", - "default" : false - }, - "representationClassSerializable" : { - "type" : "boolean", - "default" : false - } - } - }, - "DataHandler" : { - "type" : "object", - "properties" : { - "dataSource" : { - "$ref" : "#/definitions/DataSource" - }, - "name" : { - "type" : "string" - }, - "inputStream" : { - "$ref" : "#/definitions/InputStream" - }, - "content" : { - "type" : "object" - }, - "contentType" : { - "type" : "string" - }, - "outputStream" : { - "$ref" : "#/definitions/OutputStream" - }, - "allCommands" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/CommandInfo" - } - }, - "preferredCommands" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/CommandInfo" - } - }, - "transferDataFlavors" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/DataFlavor" - } - } - } - }, - "DataSource" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string" - }, - "inputStream" : { - "$ref" : "#/definitions/InputStream" - }, - "contentType" : { - "type" : "string" - }, - "outputStream" : { - "$ref" : "#/definitions/OutputStream" - } - } - }, - "EntitlementPoolEntity" : { - "type" : "object", - "required" : [ "aggregationFunction", "description", "entitlementMetric", "manufacturerReferenceNumber", "name", "operationalScope", "thresholdUnits", "thresholdValue", "time" ], - "properties" : { - "name" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 120 - }, - "description" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 1000 - }, - "thresholdValue" : { - "type" : "integer", - "format" : "int32" - }, - "thresholdUnits" : { - "type" : "string", - "enum" : [ "Absolute", "Percentage" ] - }, - "entitlementMetric" : { - "$ref" : "#/definitions/ChoiceOrOtherDtoEntitlementMetric" - }, - "increments" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 120 - }, - "aggregationFunction" : { - "$ref" : "#/definitions/ChoiceOrOtherDtoAggregationFunction" - }, - "operationalScope" : { - "$ref" : "#/definitions/MultiChoiceOrOtherDtoOperationalScope" - }, - "time" : { - "$ref" : "#/definitions/ChoiceOrOtherDtoEntitlementTime" - }, - "manufacturerReferenceNumber" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 100 - }, - "id" : { - "type" : "string" - }, - "referencingFeatureGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "EntitlementPoolRequest" : { - "type" : "object", - "required" : [ "aggregationFunction", "description", "entitlementMetric", "manufacturerReferenceNumber", "name", "operationalScope", "thresholdUnits", "thresholdValue", "time" ], - "properties" : { - "name" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 120 - }, - "description" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 1000 - }, - "thresholdValue" : { - "type" : "integer", - "format" : "int32" - }, - "thresholdUnits" : { - "type" : "string", - "enum" : [ "Absolute", "Percentage" ] - }, - "entitlementMetric" : { - "$ref" : "#/definitions/ChoiceOrOtherDtoEntitlementMetric" - }, - "increments" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 120 - }, - "aggregationFunction" : { - "$ref" : "#/definitions/ChoiceOrOtherDtoAggregationFunction" - }, - "operationalScope" : { - "$ref" : "#/definitions/MultiChoiceOrOtherDtoOperationalScope" - }, - "time" : { - "$ref" : "#/definitions/ChoiceOrOtherDtoEntitlementTime" - }, - "manufacturerReferenceNumber" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 100 - } - } - }, - "ErrorMessage" : { - "type" : "object", - "properties" : { - "level" : { - "type" : "string", - "enum" : [ "ERROR", "WARNING", "INFO" ] - }, - "message" : { - "type" : "string" - } - } - }, - "FeatureGroupEntity" : { - "type" : "object", - "required" : [ "description", "name", "partNumber" ], - "properties" : { - "name" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 120 - }, - "description" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 1000 - }, - "partNumber" : { - "type" : "string" - }, - "id" : { - "type" : "string" - }, - "licenseKeyGroupsIds" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "entitlementPoolsIds" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "referencingLicenseAgreements" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "FeatureGroupModel" : { - "type" : "object", - "required" : [ "description", "name", "partNumber" ], - "properties" : { - "name" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 120 - }, - "description" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 1000 - }, - "partNumber" : { - "type" : "string" - }, - "id" : { - "type" : "string" - }, - "referencingLicenseAgreements" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "licenseKeyGroups" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/LicenseKeyGroupEntityDto" - } - }, - "entitlementPools" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/EntitlementPoolEntity" - } - } - } - }, - "FeatureGroupRequest" : { - "type" : "object", - "required" : [ "description", "name", "partNumber" ], - "properties" : { - "name" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 120 - }, - "description" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 1000 - }, - "partNumber" : { - "type" : "string" - }, - "addedLicenseKeyGroupsIds" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "addedEntitlementPoolsIds" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "FeatureGroupUpdateRequest" : { - "type" : "object", - "required" : [ "description", "name", "partNumber" ], - "properties" : { - "name" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 120 - }, - "description" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 1000 - }, - "partNumber" : { - "type" : "string" - }, - "addedLicenseKeyGroupsIds" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "addedEntitlementPoolsIds" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "removedLicenseKeyGroupsIds" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "removedEntitlementPoolsIds" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "File" : { - "type" : "object", - "properties" : { - "path" : { - "type" : "string" - }, - "name" : { - "type" : "string" - }, - "canonicalPath" : { - "type" : "string" - }, - "parent" : { - "type" : "string" - }, - "absolute" : { - "type" : "boolean", - "default" : false - }, - "absoluteFile" : { - "$ref" : "#/definitions/File" - }, - "absolutePath" : { - "type" : "string" - }, - "canonicalFile" : { - "$ref" : "#/definitions/File" - }, - "freeSpace" : { - "type" : "integer", - "format" : "int64" - }, - "parentFile" : { - "$ref" : "#/definitions/File" - }, - "totalSpace" : { - "type" : "integer", - "format" : "int64" - }, - "usableSpace" : { - "type" : "integer", - "format" : "int64" - }, - "directory" : { - "type" : "boolean", - "default" : false - }, - "file" : { - "type" : "boolean", - "default" : false - }, - "hidden" : { - "type" : "boolean", - "default" : false - } - } - }, - "InputStream" : { - "type" : "object" - }, - "LicenseAgreementEntity" : { - "type" : "object", - "required" : [ "description", "licenseTerm", "name" ], - "properties" : { - "name" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 120 - }, - "description" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 1000 - }, - "licenseTerm" : { - "$ref" : "#/definitions/ChoiceOrOtherDtoLicenseTerm" - }, - "requirementsAndConstrains" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 1000 - }, - "id" : { - "type" : "string" - }, - "featureGroupsIds" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "LicenseAgreementModel" : { - "type" : "object", - "required" : [ "description", "licenseTerm", "name" ], - "properties" : { - "name" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 120 - }, - "description" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 1000 - }, - "licenseTerm" : { - "$ref" : "#/definitions/ChoiceOrOtherDtoLicenseTerm" - }, - "requirementsAndConstrains" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 1000 - }, - "id" : { - "type" : "string" - }, - "featureGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "$ref" : "#/definitions/FeatureGroupEntity" - } - } - } - }, - "LicenseAgreementRequest" : { - "type" : "object", - "required" : [ "description", "licenseTerm", "name" ], - "properties" : { - "name" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 120 - }, - "description" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 1000 - }, - "licenseTerm" : { - "$ref" : "#/definitions/ChoiceOrOtherDtoLicenseTerm" - }, - "requirementsAndConstrains" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 1000 - }, - "addedFeatureGroupsIds" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "LicenseAgreementUpdateRequest" : { - "type" : "object", - "required" : [ "description", "licenseTerm", "name" ], - "properties" : { - "name" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 120 - }, - "description" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 1000 - }, - "licenseTerm" : { - "$ref" : "#/definitions/ChoiceOrOtherDtoLicenseTerm" - }, - "requirementsAndConstrains" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 1000 - }, - "addedFeatureGroupsIds" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - }, - "removedFeatureGroupsIds" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "LicenseKeyGroupEntityDto" : { - "type" : "object", - "required" : [ "description", "name", "operationalScope", "type" ], - "properties" : { - "name" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 120 - }, - "description" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 1000 - }, - "type" : { - "type" : "string", - "enum" : [ "Universal", "Unique", "One_Time" ] - }, - "operationalScope" : { - "$ref" : "#/definitions/MultiChoiceOrOtherDtoOperationalScope" - }, - "id" : { - "type" : "string" - }, - "referencingFeatureGroups" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "type" : "string" - } - } - } - }, - "LicenseKeyGroupRequestDto" : { - "type" : "object", - "required" : [ "description", "name", "operationalScope", "type" ], - "properties" : { - "name" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 120 - }, - "description" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 1000 - }, - "type" : { - "type" : "string", - "enum" : [ "Universal", "Unique", "One_Time" ] - }, - "operationalScope" : { - "$ref" : "#/definitions/MultiChoiceOrOtherDtoOperationalScope" - } - } - }, - "LicensingData" : { - "type" : "object", - "properties" : { - "licenseAgreement" : { - "type" : "string" - }, - "featureGroups" : { - "type" : "array", - "items" : { - "type" : "string" - } - } - } - }, - "MediaType" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string" - }, - "subtype" : { - "type" : "string" - }, - "parameters" : { - "type" : "object", - "additionalProperties" : { - "type" : "string" - } - }, - "wildcardType" : { - "type" : "boolean", - "default" : false - }, - "wildcardSubtype" : { - "type" : "boolean", - "default" : false - } - } - }, - "MibUploadStatusDto" : { - "type" : "object", - "properties" : { - "snmpTrap" : { - "type" : "string" - }, - "snmpPoll" : { - "type" : "string" - } - } - }, - "MultiChoiceOrOtherDtoOperationalScope" : { - "type" : "object", - "required" : [ "choices", "other" ], - "properties" : { - "choices" : { - "type" : "array", - "uniqueItems" : true, - "items" : { - "type" : "string", - "enum" : [ "Network_Wide", "Availability_Zone", "Data_Center", "Tenant", "VM", "CPU", "Core", "Other" ] - } - }, - "other" : { - "type" : "string" - } - } - }, - "NetworkDto" : { - "type" : "object", - "required" : [ "dhcp", "name" ], - "properties" : { - "name" : { - "type" : "string" - }, - "dhcp" : { - "type" : "boolean", - "default" : false - }, - "id" : { - "type" : "string" - } - } - }, - "NetworkRequestDto" : { - "type" : "object", - "required" : [ "dhcp", "name" ], - "properties" : { - "name" : { - "type" : "string" - }, - "dhcp" : { - "type" : "boolean", - "default" : false - } - } - }, - "NicDto" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string" - }, - "description" : { - "type" : "string" - }, - "networkId" : { - "type" : "string" - }, - "id" : { - "type" : "string" - }, - "networkName" : { - "type" : "string" - } - } - }, - "NicRequestDto" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string" - }, - "description" : { - "type" : "string" - }, - "networkId" : { - "type" : "string" - } - } - }, - "OutputStream" : { - "type" : "object" - }, - "PackageInfoDto" : { - "type" : "object", - "properties" : { - "displayName" : { - "type" : "string" - }, - "description" : { - "type" : "string" - }, - "vspName" : { - "type" : "string" - }, - "version" : { - "type" : "string" - }, - "packageId" : { - "type" : "string" - }, - "category" : { - "type" : "string" - }, - "subCategory" : { - "type" : "string" - }, - "vendorName" : { - "type" : "string" - }, - "vendorRelease" : { - "type" : "string" - }, - "packageChecksum" : { - "type" : "string" - }, - "packageType" : { - "type" : "string" - } - } - }, - "ProcessEntityDto" : { - "type" : "object", - "required" : [ "name" ], - "properties" : { - "name" : { - "type" : "string" - }, - "description" : { - "type" : "string" - }, - "id" : { - "type" : "string" - }, - "artifactName" : { - "type" : "string" - } - } - }, - "ProcessRequestDto" : { - "type" : "object", - "required" : [ "name" ], - "properties" : { - "name" : { - "type" : "string" - }, - "description" : { - "type" : "string" - } - } - }, - "QuestionnaireResponseDto" : { - "type" : "object", - "properties" : { - "schema" : { - "type" : "string" - }, - "data" : { - "type" : "string" - } - } - }, - "UploadFileResponseDto" : { - "type" : "object", - "properties" : { - "fileNames" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "errors" : { - "type" : "object", - "additionalProperties" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ErrorMessage" - } - } - }, - "status" : { - "type" : "string", - "enum" : [ "Success", "Failure" ] - } - } - }, - "VendorLicenseModelActionRequestDto" : { - "type" : "object", - "properties" : { - "action" : { - "type" : "string", - "enum" : [ "Checkout", "Undo_Checkout", "Checkin", "Submit" ] - } - } - }, - "VendorLicenseModelEntity" : { - "type" : "object", - "required" : [ "description", "iconRef", "vendorName" ], - "properties" : { - "vendorName" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 25 - }, - "description" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 1000 - }, - "iconRef" : { - "type" : "string" - }, - "id" : { - "type" : "string" - }, - "version" : { - "type" : "string" - }, - "status" : { - "type" : "string", - "enum" : [ "Available", "Locked", "Final" ] - }, - "lockingUser" : { - "type" : "string" - }, - "viewableVersions" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "finalVersions" : { - "type" : "array", - "items" : { - "type" : "string" - } - } - } - }, - "VendorLicenseModelRequest" : { - "type" : "object", - "required" : [ "description", "iconRef", "vendorName" ], - "properties" : { - "vendorName" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 25 - }, - "description" : { - "type" : "string", - "minLength" : 0, - "maxLength" : 1000 - }, - "iconRef" : { - "type" : "string" - } - } - }, - "VersionSoftwareProductActionRequestDto" : { - "type" : "object", - "properties" : { - "action" : { - "type" : "string", - "enum" : [ "Checkout", "Undo_Checkout", "Checkin", "Submit", "Create_Package" ] - } - } - }, - "VspCreationDto" : { - "type" : "object", - "properties" : { - "vspId" : { - "type" : "string" - } - } - }, - "VspDescriptionDto" : { - "type" : "object", - "required" : [ "category", "description", "name", "subCategory", "vendorId", "vendorName" ], - "properties" : { - "name" : { - "type" : "string" - }, - "description" : { - "type" : "string" - }, - "icon" : { - "type" : "string" - }, - "category" : { - "type" : "string" - }, - "subCategory" : { - "type" : "string" - }, - "vendorName" : { - "type" : "string" - }, - "vendorId" : { - "type" : "string" - }, - "licensingVersion" : { - "type" : "string" - }, - "licensingData" : { - "$ref" : "#/definitions/LicensingData" - } - } - } - } -} \ No newline at end of file diff --git a/openecomp-be/tools/swagger-ui/lang/en.js b/openecomp-be/tools/swagger-ui/lang/en.js index 9ed12ccffb..776a8b72e0 100644 --- a/openecomp-be/tools/swagger-ui/lang/en.js +++ b/openecomp-be/tools/swagger-ui/lang/en.js @@ -1,23 +1,3 @@ -/*- - * ============LICENSE_START======================================================= - * SDC - * ================================================================================ - * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * ============LICENSE_END========================================================= - */ - 'use strict'; /* jshint quotmark: double */ diff --git a/openecomp-be/tools/swagger-ui/lang/es.js b/openecomp-be/tools/swagger-ui/lang/es.js index bd948fc27b..a8dff60b6a 100644 --- a/openecomp-be/tools/swagger-ui/lang/es.js +++ b/openecomp-be/tools/swagger-ui/lang/es.js @@ -1,23 +1,3 @@ -/*- - * ============LICENSE_START======================================================= - * SDC - * ================================================================================ - * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * ============LICENSE_END========================================================= - */ - 'use strict'; /* jshint quotmark: double */ diff --git a/openecomp-be/tools/swagger-ui/lang/ja.js b/openecomp-be/tools/swagger-ui/lang/ja.js index 895353c525..3207bfc0ba 100644 --- a/openecomp-be/tools/swagger-ui/lang/ja.js +++ b/openecomp-be/tools/swagger-ui/lang/ja.js @@ -1,30 +1,10 @@ -/*- - * ============LICENSE_START======================================================= - * SDC - * ================================================================================ - * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * ============LICENSE_END========================================================= - */ - 'use strict'; /* jshint quotmark: double */ window.SwaggerTranslator.learn({ "Warning: Deprecated":"警告: 廃止予定", "Implementation Notes":"実装メモ", - "Response Class":"レス�?ンスクラス", + "Response Class":"レスãƒãƒ³ã‚¹ã‚¯ãƒ©ã‚¹", "Status":"ステータス", "Parameters":"パラメータ群", "Parameter":"パラメータ", @@ -32,42 +12,42 @@ window.SwaggerTranslator.learn({ "Description":"説明", "Parameter Type":"パラメータタイプ", "Data Type":"データタイプ", - "Response Messages":"レス�?ンスメッセージ", + "Response Messages":"レスãƒãƒ³ã‚¹ãƒ¡ãƒƒã‚»ãƒ¼ã‚¸", "HTTP Status Code":"HTTPステータスコード", - "Reason":"�?�由", - "Response Model":"レス�?ンスモデル", + "Reason":"ç†ç”±", + "Response Model":"レスãƒãƒ³ã‚¹ãƒ¢ãƒ‡ãƒ«", "Request URL":"リクエストURL", - "Response Body":"レス�?ンスボディ", - "Response Code":"レス�?ンスコード", - "Response Headers":"レス�?ンスヘッダ", - "Hide Response":"レス�?ンスを隠�?�", + "Response Body":"レスãƒãƒ³ã‚¹ãƒœãƒ‡ã‚£", + "Response Code":"レスãƒãƒ³ã‚¹ã‚³ãƒ¼ãƒ‰", + "Response Headers":"レスãƒãƒ³ã‚¹ãƒ˜ãƒƒãƒ€", + "Hide Response":"レスãƒãƒ³ã‚¹ã‚’éš ã™", "Headers":"ヘッダ", - "Try it out!":"実際�?�実行!", - "Show/Hide":"表示/�?�表示", - "List Operations":"�?作一覧", - "Expand Operations":"�?作�?�展開", + "Try it out!":"実際ã«å®Ÿè¡Œ!", + "Show/Hide":"表示/éžè¡¨ç¤º", + "List Operations":"æ“作一覧", + "Expand Operations":"æ“作ã®å±•é–‹", "Raw":"Raw", - "can't parse JSON. Raw result":"JSON�?�解釈�?��??�?��?�ん. 未加工�?��?æžœ", + "can't parse JSON. Raw result":"JSONã¸è§£é‡ˆã§ãã¾ã›ã‚“. 未加工ã®çµæžœ", "Model Schema":"モデルスキーマ", "Model":"モデル", "apply":"実行", - "Username":"ユーザ�??", + "Username":"ユーザå", "Password":"パスワード", - "Terms of service":"サービス利用�?ç´„", + "Terms of service":"サービス利用è¦ç´„", "Created by":"Created by", "See more at":"See more at", - "Contact the developer":"開発者�?�連絡", - "api version":"API�?ージョン", - "Response Content Type":"レス�?ンス コンテンツタイプ", - "fetching resource":"リソース�?��?�得", - "fetching resource list":"リソース一覧�?��?�得", + "Contact the developer":"開発者ã«é€£çµ¡", + "api version":"APIãƒãƒ¼ã‚¸ãƒ§ãƒ³", + "Response Content Type":"レスãƒãƒ³ã‚¹ コンテンツタイプ", + "fetching resource":"リソースã®å–å¾—", + "fetching resource list":"リソース一覧ã®å–å¾—", "Explore":"Explore", - "Show Swagger Petstore Example Apis":"SwaggerペットストアAPI�?�表示", - "Can't read from server. It may not have the appropriate access-control-origin settings.":"サー�?�?�ら読�?�込�?�?��?�ん. �?�切�?�access-control-origin設定を�?�?��?��?��?��?��?�能性�?��?�り�?��?�.", - "Please specify the protocol for":"プロトコルを指定�?��?��??�?��?��?�", - "Can't read swagger JSON from":"次�?�らswagger JSONを読�?�込�?�?��?�ん", - "Finished Loading Resource Information. Rendering Swagger UI":"リソース情報�?�読�?�込�?��?�完了�?��?��?��?�. Swagger UIを�??画�?��?��?��?��?�", - "Unable to read api":"APIを読�?�込�?�?��?�ん", - "from path":"次�?�パス�?�ら", - "server returned":"サー�?�?�ら�?�返答" + "Show Swagger Petstore Example Apis":"SwaggerペットストアAPIã®è¡¨ç¤º", + "Can't read from server. It may not have the appropriate access-control-origin settings.":"サーãƒã‹ã‚‰èª­ã¿è¾¼ã‚ã¾ã›ã‚“. é©åˆ‡ãªaccess-control-origin設定をæŒã£ã¦ã„ãªã„å¯èƒ½æ€§ãŒã‚ã‚Šã¾ã™.", + "Please specify the protocol for":"プロトコルを指定ã—ã¦ãã ã•ã„", + "Can't read swagger JSON from":"次ã‹ã‚‰swagger JSONを読ã¿è¾¼ã‚ã¾ã›ã‚“", + "Finished Loading Resource Information. Rendering Swagger UI":"リソース情報ã®èª­ã¿è¾¼ã¿ãŒå®Œäº†ã—ã¾ã—ãŸ. Swagger UIã‚’æç”»ã—ã¦ã„ã¾ã™", + "Unable to read api":"APIを読ã¿è¾¼ã‚ã¾ã›ã‚“", + "from path":"次ã®ãƒ‘スã‹ã‚‰", + "server returned":"サーãƒã‹ã‚‰ã®è¿”ç­”" }); diff --git a/openecomp-be/tools/swagger-ui/lang/pt.js b/openecomp-be/tools/swagger-ui/lang/pt.js index a74b4a3d01..f2e7c13d41 100644 --- a/openecomp-be/tools/swagger-ui/lang/pt.js +++ b/openecomp-be/tools/swagger-ui/lang/pt.js @@ -1,23 +1,3 @@ -/*- - * ============LICENSE_START======================================================= - * SDC - * ================================================================================ - * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * ============LICENSE_END========================================================= - */ - 'use strict'; /* jshint quotmark: double */ diff --git a/openecomp-be/tools/swagger-ui/lang/ru.js b/openecomp-be/tools/swagger-ui/lang/ru.js index ce117fd84e..065100f73f 100644 --- a/openecomp-be/tools/swagger-ui/lang/ru.js +++ b/openecomp-be/tools/swagger-ui/lang/ru.js @@ -1,23 +1,3 @@ -/*- - * ============LICENSE_START======================================================= - * SDC - * ================================================================================ - * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * ============LICENSE_END========================================================= - */ - 'use strict'; /* jshint quotmark: double */ @@ -25,48 +5,48 @@ window.SwaggerTranslator.learn({ "Warning: Deprecated":"Ворнинг: Депрекейтед", "Implementation Notes":"Заметки", "Response Class":"Пример ответа", - "Status":"Стату�?", + "Status":"СтатуÑ", "Parameters":"Параметры", "Parameter":"Параметр", "Value":"Значение", - "Description":"Опи�?ание", + "Description":"ОпиÑание", "Parameter Type":"Тип параметра", "Data Type":"Тип данных", "HTTP Status Code":"HTTP код", "Reason":"Причина", "Response Model":"Структура ответа", - "Request URL":"URL запро�?а", + "Request URL":"URL запроÑа", "Response Body":"Тело ответа", "Response Code":"HTTP код ответа", "Response Headers":"Заголовки ответа", - "Hide Response":"Спр�?тать ответ", + "Hide Response":"СпрÑтать ответ", "Response Messages":"Что может прийти в ответ", "Try it out!":"Попробовать!", "Show/Hide":"Показать/Скрыть", "List Operations":"Операции кратко", "Expand Operations":"Операции подробно", - "Raw":"Ð’ �?ыром виде", - "can't parse JSON. Raw result":"�?е удает�?�? ра�?пар�?ить ответ:", + "Raw":"Ð’ Ñыром виде", + "can't parse JSON. Raw result":"Ðе удаетÑÑ Ñ€Ð°ÑпарÑить ответ:", "Model Schema":"Структура", - "Model":"Опи�?ание", + "Model":"ОпиÑание", "apply":"применить", - "Username":"Им�? пользовател�?", + "Username":"Ð˜Ð¼Ñ Ð¿Ð¾Ð»ÑŒÐ·Ð¾Ð²Ð°Ñ‚ÐµÐ»Ñ", "Password":"Пароль", - "Terms of service":"У�?лови�? и�?пользовани�?", + "Terms of service":"УÑÐ»Ð¾Ð²Ð¸Ñ Ð¸ÑпользованиÑ", "Created by":"Разработано", "See more at":"Еще тут", - "Contact the developer":"Св�?зать�?�? �? разработчиком", - "api version":"Вер�?и�? API", + "Contact the developer":"СвÑзатьÑÑ Ñ Ñ€Ð°Ð·Ñ€Ð°Ð±Ð¾Ñ‚Ñ‡Ð¸ÐºÐ¾Ð¼", + "api version":"ВерÑÐ¸Ñ API", "Response Content Type":"Content Type ответа", - "fetching resource":"Получение ре�?ур�?а", - "fetching resource list":"Получение ре�?ур�?ов", + "fetching resource":"Получение реÑурÑа", + "fetching resource list":"Получение реÑурÑов", "Explore":"Поехали", - "Show Swagger Petstore Example Apis":"Показать примеры �?ПИ", - "Can't read from server. It may not have the appropriate access-control-origin settings.":"�?е удает�?�? получить ответ от �?ервера. Возможно, кака�?-то лажа �? на�?тройками до�?тупа", - "Please specify the protocol for":"Пожалуй�?та, укажите протогол дл�?", - "Can't read swagger JSON from":"�?е получает�?�? прочитать swagger json из", - "Finished Loading Resource Information. Rendering Swagger UI":"Загрузка информации о ре�?ур�?ах завершена. Рендерим", - "Unable to read api":"�?е удало�?ÑŒ прочитать api", - "from path":"по адре�?у", - "server returned":"�?ервер �?казал" + "Show Swagger Petstore Example Apis":"Показать примеры ÐПИ", + "Can't read from server. It may not have the appropriate access-control-origin settings.":"Ðе удаетÑÑ Ð¿Ð¾Ð»ÑƒÑ‡Ð¸Ñ‚ÑŒ ответ от Ñервера. Возможно, какаÑ-то лажа Ñ Ð½Ð°Ñтройками доÑтупа", + "Please specify the protocol for":"ПожалуйÑта, укажите протогол длÑ", + "Can't read swagger JSON from":"Ðе получаетÑÑ Ð¿Ñ€Ð¾Ñ‡Ð¸Ñ‚Ð°Ñ‚ÑŒ swagger json из", + "Finished Loading Resource Information. Rendering Swagger UI":"Загрузка информации о реÑурÑах завершена. Рендерим", + "Unable to read api":"Ðе удалоÑÑŒ прочитать api", + "from path":"по адреÑу", + "server returned":"Ñервер Ñказал" }); diff --git a/openecomp-be/tools/swagger-ui/lang/tr.js b/openecomp-be/tools/swagger-ui/lang/tr.js index 359583e4b4..16426a9c34 100644 --- a/openecomp-be/tools/swagger-ui/lang/tr.js +++ b/openecomp-be/tools/swagger-ui/lang/tr.js @@ -1,23 +1,3 @@ -/*- - * ============LICENSE_START======================================================= - * SDC - * ================================================================================ - * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * ============LICENSE_END========================================================= - */ - 'use strict'; /* jshint quotmark: double */ diff --git a/openecomp-be/tools/swagger-ui/lang/translator.js b/openecomp-be/tools/swagger-ui/lang/translator.js index 9232ac18a6..591f6d4094 100644 --- a/openecomp-be/tools/swagger-ui/lang/translator.js +++ b/openecomp-be/tools/swagger-ui/lang/translator.js @@ -1,23 +1,3 @@ -/*- - * ============LICENSE_START======================================================= - * SDC - * ================================================================================ - * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * ============LICENSE_END========================================================= - */ - 'use strict'; /** diff --git a/openecomp-be/tools/swagger-ui/lang/zh-cn.js b/openecomp-be/tools/swagger-ui/lang/zh-cn.js index e1fde6e7cc..570319ba15 100644 --- a/openecomp-be/tools/swagger-ui/lang/zh-cn.js +++ b/openecomp-be/tools/swagger-ui/lang/zh-cn.js @@ -1,73 +1,53 @@ -/*- - * ============LICENSE_START======================================================= - * SDC - * ================================================================================ - * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * ============LICENSE_END========================================================= - */ - 'use strict'; /* jshint quotmark: double */ window.SwaggerTranslator.learn({ "Warning: Deprecated":"警告：已过时", "Implementation Notes":"实现备注", - "Response Class":"�?应类", - "Status":"状�?", - "Parameters":"�?�数", - "Parameter":"�?�数", + "Response Class":"å“应类", + "Status":"状æ€", + "Parameters":"å‚æ•°", + "Parameter":"å‚æ•°", "Value":"值", - "Description":"�??è¿°", - "Parameter Type":"�?�数类型", - "Data Type":"数�?�类型", - "Response Messages":"�?应消�?�", - "HTTP Status Code":"HTTP状�?�?", + "Description":"æè¿°", + "Parameter Type":"å‚数类型", + "Data Type":"æ•°æ®ç±»åž‹", + "Response Messages":"å“应消æ¯", + "HTTP Status Code":"HTTP状æ€ç ", "Reason":"原因", - "Response Model":"�?应模型", + "Response Model":"å“应模型", "Request URL":"请求URL", - "Response Body":"�?应体", - "Response Code":"�?应�?", - "Response Headers":"�?应头", - "Hide Response":"�?�?�?应", + "Response Body":"å“应体", + "Response Code":"å“应ç ", + "Response Headers":"å“应头", + "Hide Response":"éšè—å“应", "Headers":"头", - "Try it out!":"试一下�?", - "Show/Hide":"显示/�?�?", - "List Operations":"显示�?作", - "Expand Operations":"展开�?作", + "Try it out!":"试一下ï¼", + "Show/Hide":"显示/éšè—", + "List Operations":"显示æ“作", + "Expand Operations":"展开æ“作", "Raw":"原始", - "can't parse JSON. Raw result":"无法解�?JSON. 原始结果", + "can't parse JSON. Raw result":"无法解æžJSON. 原始结果", "Model Schema":"模型架构", "Model":"模型", "apply":"应用", - "Username":"用户�??", - "Password":"密�?", - "Terms of service":"�?务�?�款", + "Username":"用户å", + "Password":"密ç ", + "Terms of service":"æœåŠ¡æ¡æ¬¾", "Created by":"创建者", "See more at":"查看更多：", - "Contact the developer":"�?�系开�?�者", + "Contact the developer":"è”系开å‘者", "api version":"api版本", - "Response Content Type":"�?应Content Type", - "fetching resource":"正在获�?�资�?", - "fetching resource list":"正在获�?�资�?列表", - "Explore":"�?览", + "Response Content Type":"å“应Content Type", + "fetching resource":"正在获å–资æº", + "fetching resource list":"正在获å–资æºåˆ—表", + "Explore":"æµè§ˆ", "Show Swagger Petstore Example Apis":"显示 Swagger Petstore 示例 Apis", - "Can't read from server. It may not have the appropriate access-control-origin settings.":"无法从�?务器读�?�。�?�能没有正确设置access-control-origin。", - "Please specify the protocol for":"请指定�??议：", - "Can't read swagger JSON from":"无法读�?�swagger JSON于", - "Finished Loading Resource Information. Rendering Swagger UI":"已加载资�?信�?�。正在渲染Swagger UI", - "Unable to read api":"无法读�?�api", + "Can't read from server. It may not have the appropriate access-control-origin settings.":"无法从æœåŠ¡å™¨è¯»å–。å¯èƒ½æ²¡æœ‰æ­£ç¡®è®¾ç½®access-control-origin。", + "Please specify the protocol for":"请指定å议：", + "Can't read swagger JSON from":"无法读å–swagger JSON于", + "Finished Loading Resource Information. Rendering Swagger UI":"已加载资æºä¿¡æ¯ã€‚正在渲染Swagger UI", + "Unable to read api":"无法读å–api", "from path":"从路径", - "server returned":"�?务器返回" + "server returned":"æœåŠ¡å™¨è¿”回" }); diff --git a/openecomp-be/tools/swagger-ui/lib/backbone-min.js b/openecomp-be/tools/swagger-ui/lib/backbone-min.js index f082fcffca..a3f544be6d 100644 --- a/openecomp-be/tools/swagger-ui/lib/backbone-min.js +++ b/openecomp-be/tools/swagger-ui/lib/backbone-min.js @@ -1,23 +1,3 @@ -/*- - * ============LICENSE_START======================================================= - * SDC - * ================================================================================ - * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved. - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * ============LICENSE_END========================================================= - */ - // Backbone.js 1.1.2 (function(t,e){if(typeof define==="function"&&define.amd){define(["underscore","jquery","exports"],function(i,r,s){t.Backbone=e(t,s,i,r)})}else if(typeof exports!=="undefined"){var i=require("underscore");e(t,exports,i)}else{t.Backbone=e(t,{},t._,t.jQuery||t.Zepto||t.ender||t.$)}})(this,function(t,e,i,r){var s=t.Backbone;var n=[];var a=n.push;var o=n.slice;var h=n.splice;e.VERSION="1.1.2";e.$=r;e.noConflict=function(){t.Backbone=s;return this};e.emulateHTTP=false;e.emulateJSON=false;var u=e.Events={on:function(t,e,i){if(!c(this,"on",t,[e,i])||!e)return this;this._events||(this._events={});var r=this._events[t]||(this._events[t]=[]);r.push({callback:e,context:i,ctx:i||this});return this},once:function(t,e,r){if(!c(this,"once",t,[e,r])||!e)return this;var s=this;var n=i.once(function(){s.off(t,n);e.apply(this,arguments)});n._callback=e;return this.on(t,n,r)},off:function(t,e,r){var s,n,a,o,h,u,l,f;if(!this._events||!c(this,"off",t,[e,r]))return this;if(!t&&!e&&!r){this._events=void 0;return this}o=t?[t]:i.keys(this._events);for(h=0,u=o.length;h").attr(t);this.setElement(r,false)}else{this.setElement(i.result(this,"el"),false)}}});e.sync=function(t,r,s){var n=T[t];i.defaults(s||(s={}),{emulateHTTP:e.emulateHTTP,emulateJSON:e.emulateJSON});var a={type:n,dataType:"json"};if(!s.url){a.url=i.result(r,"url")||M()}if(s.data==null&&r&&(t==="create"||t==="update"||t==="patch")){a.contentType="application/json";a.data=JSON.stringify(s.attrs||r.toJSON(s))}if(s.emulateJSON){a.contentType="application/x-www-form-urlencoded";a.data=a.data?{model:a.data}:{}}if(s.emulateHTTP&&(n==="PUT"||n==="DELETE"||n==="PATCH")){a.type="POST";if(s.emulateJSON)a.data._method=n;var o=s.beforeSend;s.beforeSend=function(t){t.setRequestHeader("X-HTTP-Method-Override",n);if(o)return o.apply(this,arguments)}}if(a.type!=="GET"&&!s.emulateJSON){a.processData=false}if(a.type==="PATCH"&&k){a.xhr=function(){return new ActiveXObject("Microsoft.XMLHTTP")}}var h=s.xhr=e.ajax(i.extend(a,s));r.trigger("request",r,h,s);return h};var k=typeof window!=="undefined"&&!!window.ActiveXObject&&!(window.XMLHttpRequest&&(new XMLHttpRequest).dispatchEvent);var T={create:"POST",update:"PUT",patch:"PATCH","delete":"DELETE",read:"GET"};e.ajax=function(){return e.$.ajax.apply(e.$,arguments)};var $=e.Router=function(t){t||(t={});if(t.routes)this.routes=t.routes;this._bindRoutes();this.initialize.apply(this,arguments)};var S=/\((.*?)\)/g;var H=/(\(\?)?:\w+/g;var A=/\*\w+/g;var I=/[\-{}\[\]+?.,\\\^$|#\s]/g;i.extend($.prototype,u,{initialize:function(){},route:function(t,r,s){if(!i.isRegExp(t))t=this._routeToRegExp(t);if(i.isFunction(r)){s=r;r=""}if(!s)s=this[r];var n=this;e.history.route(t,function(i){var a=n._extractParameters(t,i);n.execute(s,a);n.trigger.apply(n,["route:"+r].concat(a));n.trigger("route",r,a);e.history.trigger("route",n,r,a)});return this},execute:function(t,e){if(t)t.apply(this,e)},navigate:function(t,i){e.history.navigate(t,i);return this},_bindRoutes:function(){if(!this.routes)return;this.routes=i.result(this,"routes");var t,e=i.keys(this.routes);while((t=e.pop())!=null){this.route(t,this.routes[t])}},_routeToRegExp:function(t){t=t.replace(I,"\\$&").replace(S,"(?:$1)?").replace(H,function(t,e){return e?t:"([^/?]+)"}).replace(A,"([^?]*?)");return new RegExp("^"+t+"(?:\\?([\\s\\S]*))?$")},_extractParameters:function(t,e){var r=t.exec(e).slice(1);return i.map(r,function(t,e){if(e===r.length-1)return t||null;return t?decodeURIComponent(t):null})}});var N=e.History=function(){this.handlers=[];i.bindAll(this,"checkUrl");if(typeof window!=="undefined"){this.location=window.location;this.history=window.history}};var R=/^[#\/]|\s+$/g;var O=/^\/+|\/+$/g;var P=/msie [\w.]+/;var C=/\/$/;var j=/#.*$/;N.started=false;i.extend(N.prototype,u,{interval:50,atRoot:function(){return this.location.pathname.replace(/[^\/]$/,"$&/")===this.root},getHash:function(t){var e=(t||this).location.href.match(/#(.*)$/);return e?e[1]:""},getFragment:function(t,e){if(t==null){if(this._hasPushState||!this._wantsHashChange||e){t=decodeURI(this.location.pathname+this.location.search);var i=this.root.replace(C,"");if(!t.indexOf(i))t=t.slice(i.length)}else{t=this.getHash()}}return t.replace(R,"")},start:function(t){if(N.started)throw new Error("Backbone.history has already been started");N.started=true;this.options=i.extend({root:"/"},this.options,t);this.root=this.options.root;this._wantsHashChange=this.options.hashChange!==false;this._wantsPushState=!!this.options.pushState;this._hasPushState=!!(this.options.pushState&&this.history&&this.history.pushState);var r=this.getFragment();var s=document.documentMode;var n=P.exec(navigator.userAgent.toLowerCase())&&(!s||s<=7);this.root=("/"+this.root+"/").replace(O,"/");if(n&&this._wantsHashChange){var a=e.$('