diff options
Diffstat (limited to 'openecomp-be/tools/swagger-ui/api-docs')
| -rw-r--r-- | openecomp-be/tools/swagger-ui/api-docs/api.html | 13140 | ||||
| -rw-r--r-- | openecomp-be/tools/swagger-ui/api-docs/api.json | 4676 |
2 files changed, 17816 insertions, 0 deletions
diff --git a/openecomp-be/tools/swagger-ui/api-docs/api.html b/openecomp-be/tools/swagger-ui/api-docs/api.html new file mode 100644 index 0000000000..35bf7db136 --- /dev/null +++ b/openecomp-be/tools/swagger-ui/api-docs/api.html @@ -0,0 +1,13140 @@ +<!DOCTYPE html> +<html> +<title>API Document</title> + +<!--xmp theme="united" style="display:none;"--> +<xmp theme="united" style="display:none;"> +#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: 'Final' - 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: 'Final' - 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>subType</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> + +</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>wildcardSubtype</td> + <td> + + + boolean + + </td> + <td>optional</td> + <td>-</td> + <td></td> + </tr> + + <tr> + <td>wildcardType</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> + +</xmp> + +<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script> +</html>
\ 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 new file mode 100644 index 0000000000..8396339628 --- /dev/null +++ b/openecomp-be/tools/swagger-ui/api-docs/api.json @@ -0,0 +1,4676 @@ +{ + "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 License Models" + }, { + "name" : "Vendor License Model - Entitlement Pools" + }, { + "name" : "Vendor Software Product Processes" + }, { + "name" : "Application Configuration" + }, { + "name" : "Actions" + }, { + "name" : "Vendor License Model - License Key Groups" + }, { + "name" : "Vendor Software Product Component Processes" + }, { + "name" : "Vendor Software Product Components" + }, { + "name" : "Validation" + }, { + "name" : "Vendor Software Product Component MIB Uploads" + }, { + "name" : "Vendor License Model - License Agreements" + }, { + "name" : "Vendor Software Product Networks" + }, { + "name" : "Vendor Software Products" + }, { + "name" : "Vendor Software Product Component NICs" + }, { + "name" : "Vendor License Model - Feature Groups" + } ], + "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" + }, + "contentDisposition" : { + "$ref" : "#/definitions/ContentDisposition" + }, + "dataHandler" : { + "$ref" : "#/definitions/DataHandler" + }, + "contentId" : { + "type" : "string" + } + } + }, + "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" + } + }, + "wildcardSubtype" : { + "type" : "boolean", + "default" : false + }, + "wildcardType" : { + "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 |