{ "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" : "Item Permissions" }, { "name" : "Validation" }, { "name" : "Vendor License Model - License Key Group Limits" }, { "name" : "Notifications" }, { "name" : "Vendor License Model - Entitlement Pool Limits" }, { "name" : "Vendor Software Product Component NICs" }, { "name" : "Vendor License Model - Entitlement Pools" }, { "name" : "Actions" }, { "name" : "Vendor License Model - License Agreements" }, { "name" : "Vendor Software Product Component Dependencies" }, { "name" : "Vendor Software Product Images" }, { "name" : "Vendor Software Product Processes" }, { "name" : "Vendor Software Product Networks" }, { "name" : "Vendor License Models" }, { "name" : "Vendor Software Products" }, { "name" : "Vendor Software Product Component Processes" }, { "name" : "Item Versions" }, { "name" : "Orchestration Template Candidate" }, { "name" : "Item Version Conflicts" }, { "name" : "Vendor Software Product deployment-flavors" }, { "name" : "Vendor License Model - Feature Groups" }, { "name" : "Vendor Software Product Component Uploads" }, { "name" : "Vendor Software Product Components" }, { "name" : "Application Configuration" }, { "name" : "Vendor Software Product Component Compute-flavors" }, { "name" : "Health Check" }, { "name" : "Vendor License Model - License Key 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/healthcheck" : { "get" : { "tags" : [ "Health Check" ], "summary" : "Perform health check", "description" : "", "operationId" : "checkHealth", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/HealthInfoDtos" } } } } } }, "/v1.0/items/{itemId}/permissions" : { "get" : { "tags" : [ "Item Permissions" ], "summary" : "List users permissions assigned on item", "description" : "", "operationId" : "list", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "itemId", "in" : "path", "required" : true, "type" : "string" }, { "name" : "USER_ID", "in" : "header", "required" : false, "type" : "string", "default" : "" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/ItemPermissionsDto" } } } } } }, "/v1.0/items/{itemId}/permissions/{permission}" : { "put" : { "tags" : [ "Item Permissions" ], "summary" : "Update useres permission on item", "description" : "", "operationId" : "updatePermissions", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/ItemPermissionsRequest" } }, { "name" : "itemId", "in" : "path", "required" : true, "type" : "string" }, { "name" : "permission", "in" : "path", "required" : true, "type" : "string" }, { "name" : "USER_ID", "in" : "header", "required" : false, "type" : "string", "default" : "" } ], "responses" : { "default" : { "description" : "successful operation" } } } }, "/v1.0/items/{itemId}/versions" : { "get" : { "tags" : [ "Item Versions" ], "summary" : "Lists item versions", "description" : "", "operationId" : "list", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "itemId", "in" : "path", "required" : true, "type" : "string" }, { "name" : "USER_ID", "in" : "header", "required" : false, "type" : "string", "default" : "" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/VersionDto" } } } } } }, "/v1.0/items/{itemId}/versions/{versionId}" : { "get" : { "tags" : [ "Item Versions" ], "summary" : "Gets item version", "description" : "", "operationId" : "get", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "itemId", "in" : "path", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "required" : true, "type" : "string" }, { "name" : "USER_ID", "in" : "header", "required" : false, "type" : "string", "default" : "" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/VersionDto" } } } }, "post" : { "tags" : [ "Item Versions" ], "summary" : "Creates a new item version", "description" : "", "operationId" : "create", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/VersionRequestDto" } }, { "name" : "itemId", "in" : "path", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "required" : true, "type" : "string" }, { "name" : "USER_ID", "in" : "header", "required" : false, "type" : "string", "default" : "" } ], "responses" : { "default" : { "description" : "successful operation" } } } }, "/v1.0/items/{itemId}/versions/{versionId}/actions" : { "put" : { "tags" : [ "Item Versions" ], "summary" : "Acts on item version", "description" : "", "operationId" : "actOn", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/VersionActionRequestDto" } }, { "name" : "itemId", "in" : "path", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "required" : true, "type" : "string" }, { "name" : "USER_ID", "in" : "header", "required" : false, "type" : "string", "default" : "" } ], "responses" : { "default" : { "description" : "successful operation" } } } }, "/v1.0/items/{itemId}/versions/{versionId}/activity-logs" : { "get" : { "tags" : [ "Item Versions" ], "summary" : "Gets item version activity log", "description" : "", "operationId" : "getActivityLog", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "itemId", "in" : "path", "description" : "Item Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Version Id", "required" : true, "type" : "string" }, { "name" : "USER_ID", "in" : "header", "required" : false, "type" : "string", "default" : "" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/ActivityLogDto" } } } } } }, "/v1.0/items/{itemId}/versions/{versionId}/conflicts" : { "get" : { "tags" : [ "Item Version Conflicts" ], "summary" : "item version conflicts", "description" : "Item version private copy conflicts against its public copy", "operationId" : "getConflict", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "itemId", "in" : "path", "description" : "Item Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Version Id", "required" : true, "type" : "string" }, { "name" : "USER_ID", "in" : "header", "required" : false, "type" : "string", "default" : "" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/ItemVersionConflictDto" } } } } }, "/v1.0/items/{itemId}/versions/{versionId}/conflicts/{conflictId}" : { "get" : { "tags" : [ "Item Version Conflicts" ], "summary" : "Gets item version conflict", "description" : "Gets an item version private copy conflict against its public copy", "operationId" : "getConflict", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "itemId", "in" : "path", "description" : "Item Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Version Id", "required" : true, "type" : "string" }, { "name" : "conflictId", "in" : "path", "description" : "Version Id", "required" : true, "type" : "string" }, { "name" : "USER_ID", "in" : "header", "required" : false, "type" : "string", "default" : "" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/ConflictDto" } } } }, "put" : { "tags" : [ "Item Version Conflicts" ], "summary" : "Resolves item version conflict", "description" : "Resolves an item version private copy conflict against its public copy", "operationId" : "resolveConflict", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/ConflictResolutionDto" } }, { "name" : "itemId", "in" : "path", "description" : "Item Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Version Id", "required" : true, "type" : "string" }, { "name" : "conflictId", "in" : "path", "description" : "Version Id", "required" : true, "type" : "string" }, { "name" : "USER_ID", "in" : "header", "required" : false, "type" : "string", "default" : "" } ], "responses" : { "default" : { "description" : "successful operation" } } } }, "/v1.0/items/{itemId}/versions/{versionId}/revisions" : { "get" : { "tags" : [ "Item Versions" ], "summary" : "Gets item version revisions", "description" : "", "operationId" : "listRevisions", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "itemId", "in" : "path", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "required" : true, "type" : "string" }, { "name" : "USER_ID", "in" : "header", "required" : false, "type" : "string", "default" : "" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/RevisionDto" } } } } } }, "/v1.0/notifications" : { "get" : { "tags" : [ "Notifications" ], "summary" : "Retrive all user notifications", "description" : "", "operationId" : "getNotifications", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "USER_ID", "in" : "header", "required" : false, "type" : "string", "default" : "" }, { "name" : "LAST_DELIVERED_EVENT_ID", "in" : "query", "required" : false, "type" : "string", "format" : "uuid" }, { "name" : "END_OF_PAGE_EVENT_ID", "in" : "query", "required" : false, "type" : "string", "format" : "uuid" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/NotificationsStatusDto" } } } } } }, "/v1.0/notifications/last-seen/{notificationId}" : { "put" : { "tags" : [ "Notifications" ], "summary" : "Update Last Seen Notification", "description" : "", "operationId" : "updateLastSeenNotification", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "notificationId", "in" : "path", "description" : "Notification Id", "required" : true, "type" : "string" }, { "name" : "USER_ID", "in" : "header", "required" : false, "type" : "string", "default" : "" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/UpdateNotificationResponseStatus" } } } } }, "/v1.0/notifications/worker" : { "get" : { "tags" : [ "Notifications" ], "summary" : "Retrive user not delivered notifications", "description" : "", "operationId" : "getNewNotificationsByOwnerId", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "USER_ID", "in" : "header", "required" : false, "type" : "string", "default" : "" }, { "name" : "LAST_DELIVERED_EVENT_ID", "in" : "query", "required" : false, "type" : "string" }, { "name" : "NOTIFICATION_ROWS_LIMIT", "in" : "query", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/NotificationsStatusDto" } } } } } }, "/v1.0/notifications/{notificationId}" : { "put" : { "tags" : [ "Notifications" ], "summary" : "Mark notification as read", "description" : "", "operationId" : "markAsRead", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "notificationId", "in" : "path", "description" : "Notification Id", "required" : true, "type" : "string" }, { "name" : "USER_ID", "in" : "header", "required" : false, "type" : "string", "default" : "" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/UpdateNotificationResponseStatus" } } } } }, "/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" }, { "name" : "validate", "in" : "formData", "required" : false, "type" : "file" } ], "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: 'Certified' - 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/ItemDto" } } } } }, "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}" : { "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}/versions/{versionId}" : { "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" : "versionId", "in" : "path", "description" : "Vendor license model version Id", "required" : true, "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" : "versionId", "in" : "path", "description" : "Vendor license model version 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}/versions/{versionId}/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" : "versionId", "in" : "path", "description" : "Vendor license model version 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}/versions/{versionId}/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" : "versionId", "in" : "path", "description" : "Vendor license model version Id", "required" : true, "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" : "versionId", "in" : "path", "description" : "Vendor license model version 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}/versions/{versionId}/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" : "versionId", "in" : "path", "description" : "Vendor license model version Id", "required" : true, "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" : "versionId", "in" : "path", "description" : "Vendor license model version 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" : "versionId", "in" : "path", "description" : "Vendor license model version 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}/versions/{versionId}/entitlement-pools/{entitlementPoolId}/limits" : { "get" : { "tags" : [ "Vendor License Model - Entitlement Pool Limits" ], "summary" : "List vendor entitlement pool limits", "description" : "", "operationId" : "listLimits", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "vlmId", "in" : "path", "description" : "Vendor license model Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Vendor license model version Id", "required" : true, "type" : "string" }, { "name" : "entitlementPoolId", "in" : "path", "description" : "Vendor license model Entitlement Pool Id", "required" : true, "type" : "string" }, { "name" : "USER_ID", "in" : "header", "required" : false, "type" : "string", "default" : "" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/LimitRequest" } } } } }, "post" : { "tags" : [ "Vendor License Model - Entitlement Pool Limits" ], "summary" : "Create vendor entitlement pool limits", "description" : "", "operationId" : "createLimit", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/LimitRequest" } }, { "name" : "vlmId", "in" : "path", "description" : "Vendor license model Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Vendor license model version Id", "required" : true, "type" : "string" }, { "name" : "entitlementPoolId", "in" : "path", "description" : "Vendor license model Entitlement Pool 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}/versions/{versionId}/entitlement-pools/{entitlementPoolId}/limits/{limitId}" : { "get" : { "tags" : [ "Vendor License Model - Entitlement Pool Limits" ], "summary" : "Get vendor entitlement pool limit", "description" : "", "operationId" : "getLimit", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "vlmId", "in" : "path", "description" : "Vendor license model Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Vendor license model version Id", "required" : true, "type" : "string" }, { "name" : "entitlementPoolId", "in" : "path", "description" : "Vendor license model Entitlement Pool Id", "required" : true, "type" : "string" }, { "name" : "limitId", "in" : "path", "description" : "Vendor license model Entitlement Pool Limit Id", "required" : true, "type" : "string" }, { "name" : "USER_ID", "in" : "header", "required" : false, "type" : "string", "default" : "" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/LimitEntityDto" } } } }, "put" : { "tags" : [ "Vendor License Model - Entitlement Pool Limits" ], "summary" : "Update vendor entitlement pool limit", "description" : "", "operationId" : "updateLimit", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/LimitRequest" } }, { "name" : "vlmId", "in" : "path", "description" : "Vendor license model Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Vendor license model version Id", "required" : true, "type" : "string" }, { "name" : "entitlementPoolId", "in" : "path", "description" : "Vendor license model Entitlement Pool Id", "required" : true, "type" : "string" }, { "name" : "limitId", "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 Pool Limits" ], "summary" : "Delete vendor entitlement pool limit", "description" : "", "operationId" : "deleteLimit", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "vlmId", "in" : "path", "description" : "Vendor license model Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Vendor license model version Id", "required" : true, "type" : "string" }, { "name" : "entitlementPoolId", "in" : "path", "description" : "Vendor license model Entitlement pool Id", "required" : true, "type" : "string" }, { "name" : "limitId", "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}/versions/{versionId}/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" : "versionId", "in" : "path", "description" : "Vendor license model version Id", "required" : true, "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" : "versionId", "in" : "path", "description" : "Vendor license model version 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}/versions/{versionId}/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" : "versionId", "in" : "path", "description" : "Vendor license model version Id", "required" : true, "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" : "versionId", "in" : "path", "description" : "Vendor license model version 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" : "versionId", "in" : "path", "description" : "Vendor license model version 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}/versions/{versionId}/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" : "versionId", "in" : "path", "description" : "Vendor license model version Id", "required" : true, "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" : "versionId", "in" : "path", "description" : "Vendor license model version 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}/versions/{versionId}/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" : "versionId", "in" : "path", "description" : "Vendor license model version Id", "required" : true, "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" : "versionId", "in" : "path", "description" : "Vendor license model version 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" : "versionId", "in" : "path", "description" : "Vendor license model version 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}/versions/{versionId}/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" : "versionId", "in" : "path", "description" : "Vendor license model version Id", "required" : true, "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" : "versionId", "in" : "path", "description" : "Vendor license model version 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}/versions/{versionId}/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" : "versionId", "in" : "path", "description" : "Vendor license model version Id", "required" : true, "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" : "versionId", "in" : "path", "description" : "Vendor license model version 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" : "versionId", "in" : "path", "description" : "Vendor license model version 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-license-models/{vlmId}/versions/{versionId}/license-key-groups/{licenseKeyGroupId}/limits" : { "get" : { "tags" : [ "Vendor License Model - License Key Group Limits" ], "summary" : "List vendor license key group limits", "description" : "", "operationId" : "listLimits", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "vlmId", "in" : "path", "description" : "Vendor license model Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Vendor license model version Id", "required" : true, "type" : "string" }, { "name" : "licenseKeyGroupId", "in" : "path", "description" : "Vendor license model License Key Group Id", "required" : true, "type" : "string" }, { "name" : "USER_ID", "in" : "header", "required" : false, "type" : "string", "default" : "" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/LimitEntityDto" } } } } }, "post" : { "tags" : [ "Vendor License Model - License Key Group Limits" ], "summary" : "Create vendor license key group limit", "description" : "", "operationId" : "createLimit", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/LimitRequest" } }, { "name" : "vlmId", "in" : "path", "description" : "Vendor license model Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Vendor license model version Id", "required" : true, "type" : "string" }, { "name" : "licenseKeyGroupId", "in" : "path", "description" : "Vendor license model License Key Group 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}/versions/{versionId}/license-key-groups/{licenseKeyGroupId}/limits/{limitId}" : { "get" : { "tags" : [ "Vendor License Model - License Key Group Limits" ], "summary" : "Get vendor entitlement pool limit", "description" : "", "operationId" : "getLimit", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "vlmId", "in" : "path", "description" : "Vendor license model Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Vendor license model version Id", "required" : true, "type" : "string" }, { "name" : "licenseKeyGroupId", "in" : "path", "description" : "Vendor license model License Key Group", "required" : true, "type" : "string" }, { "name" : "limitId", "in" : "path", "description" : "Vendor license model License Key Group Limit Id", "required" : true, "type" : "string" }, { "name" : "USER_ID", "in" : "header", "required" : false, "type" : "string", "default" : "" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/LimitEntityDto" } } } }, "put" : { "tags" : [ "Vendor License Model - License Key Group Limits" ], "summary" : "Update vendor license key group limit", "description" : "", "operationId" : "updateLimit", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/LimitRequest" } }, { "name" : "vlmId", "in" : "path", "description" : "Vendor license model Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Vendor license model version Id", "required" : true, "type" : "string" }, { "name" : "licenseKeyGroupId", "in" : "path", "description" : "Vendor license model License Key Group Id", "required" : true, "type" : "string" }, { "name" : "limitId", "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 Group Limits" ], "summary" : "Delete vendor license key group limit", "description" : "", "operationId" : "deleteLimit", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "vlmId", "in" : "path", "description" : "Vendor license model Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Vendor license model version Id", "required" : true, "type" : "string" }, { "name" : "licenseKeyGroupId", "in" : "path", "description" : "Vendor license model license key group Id", "required" : true, "type" : "string" }, { "name" : "limitId", "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" : "listVsps", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "versionFilter", "in" : "query", "description" : "Currently supported values: 'Certified' - 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" : "createVsp", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/VspRequestDto" } }, { "name" : "USER_ID", "in" : "header", "required" : false, "type" : "string", "default" : "" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/ItemCreationDto" } } } } }, "/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" : "versionId", "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}" : { "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}/versions/{versionId}" : { "get" : { "tags" : [ "Vendor Software Products" ], "summary" : "Get details of a vendor software product", "description" : "", "operationId" : "getVsp", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "vspId", "in" : "path", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "required" : true, "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" }, { "name" : "versionId", "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" } } } }, "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/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" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/VersionSoftwareProductActionRequestDto" } }, { "name" : "vspId", "in" : "path", "required" : true, "type" : "string" }, { "name" : "versionId", "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}/versions/{versionId}/component-dependencies" : { "get" : { "tags" : [ "Vendor Software Product Component Dependencies" ], "summary" : "Get component dependencies for vendor software product", "description" : "", "operationId" : "list", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "vspId", "in" : "path", "description" : "Vendor software product Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Vendor software product version Id", "required" : true, "type" : "string" }, { "name" : "USER_ID", "in" : "header", "required" : false, "type" : "string", "default" : "" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/ComponentDependencyResponseDto" } } } } }, "post" : { "tags" : [ "Vendor Software Product Component Dependencies" ], "summary" : "Create a vendor software product component dependency", "description" : "", "operationId" : "create", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/ComponentDependencyModel" } }, { "name" : "vspId", "in" : "path", "description" : "Vendor software product Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Version 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}/versions/{versionId}/component-dependencies/{dependencyId}" : { "get" : { "tags" : [ "Vendor Software Product Component Dependencies" ], "summary" : "Get component dependency for vendor software product", "description" : "", "operationId" : "get", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "vspId", "in" : "path", "description" : "Vendor software product Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Version Id", "required" : true, "type" : "string" }, { "name" : "dependencyId", "in" : "path", "description" : "Vendor software product Component Dependency Id", "required" : true, "type" : "string" }, { "name" : "USER_ID", "in" : "header", "required" : false, "type" : "string", "default" : "" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/ComponentDependencyResponseDto" } } } }, "put" : { "tags" : [ "Vendor Software Product Component Dependencies" ], "summary" : "Update component dependency for vendor software product", "description" : "", "operationId" : "update", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/ComponentDependencyModel" } }, { "name" : "vspId", "in" : "path", "description" : "Vendor software product Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Vendor software product version Id", "required" : true, "type" : "string" }, { "name" : "dependencyId", "in" : "path", "description" : "Vendor software product Component Dependency 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 Dependencies" ], "summary" : "Delete component dependency for vendor software product", "description" : "", "operationId" : "delete", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "vspId", "in" : "path", "description" : "Vendor software product Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Vendor software product version Id", "required" : true, "type" : "string" }, { "name" : "dependencyId", "in" : "path", "description" : "Vendor software product Component Dependency 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}/versions/{versionId}/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" : "versionId", "in" : "path", "description" : "Version Id", "required" : true, "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" : "versionId", "in" : "path", "description" : "Version 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" : "versionId", "in" : "path", "description" : "Version 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}/versions/{versionId}/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" : "versionId", "in" : "path", "description" : "Version 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/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" : "versionId", "in" : "path", "description" : "Version 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" : "versionId", "in" : "path", "description" : "Version 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}/versions/{versionId}/components/{componentId}/compute-flavors" : { "get" : { "tags" : [ "Vendor Software Product Component Compute-flavors" ], "summary" : "Get list of vendor software product component compute-flavors", "description" : "", "operationId" : "list", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "vspId", "in" : "path", "description" : "Vendor software product Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Version 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" : { "type" : "array", "items" : { "$ref" : "#/definitions/ComputeDto" } } } } }, "post" : { "tags" : [ "Vendor Software Product Component Compute-flavors" ], "summary" : "Create a vendor software product component compute-flavor", "description" : "", "operationId" : "create", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/ComputeDetailsDto" } }, { "name" : "vspId", "in" : "path", "description" : "Vendor software product Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Version 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}/versions/{versionId}/components/{componentId}/compute-flavors/{computeFlavorId}" : { "get" : { "tags" : [ "Vendor Software Product Component Compute-flavors" ], "summary" : "Get vendor software product component compute-flavor", "description" : "", "operationId" : "get", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "vspId", "in" : "path", "description" : "Vendor software product Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Version Id", "required" : true, "type" : "string" }, { "name" : "componentId", "in" : "path", "description" : "Vendor software product component Id", "required" : true, "type" : "string" }, { "name" : "computeFlavorId", "in" : "path", "description" : "Vendor software product compute-flavor Id", "required" : true, "type" : "string" }, { "name" : "USER_ID", "in" : "header", "required" : false, "type" : "string", "default" : "" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/ComputeDetailsDto" } } } }, "put" : { "tags" : [ "Vendor Software Product Component Compute-flavors" ], "summary" : "Update vendor software product component compute-flavor", "description" : "", "operationId" : "update", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/ComputeDetailsDto" } }, { "name" : "vspId", "in" : "path", "description" : "Vendor software product Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Version Id", "required" : true, "type" : "string" }, { "name" : "componentId", "in" : "path", "description" : "Vendor software product component Id", "required" : true, "type" : "string" }, { "name" : "computeFlavorId", "in" : "path", "description" : "Vendor software product compute-flavor 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 Compute-flavors" ], "summary" : "Delete vendor software product component compute-flavor", "description" : "", "operationId" : "delete", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "vspId", "in" : "path", "description" : "Vendor software product Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Version Id", "required" : true, "type" : "string" }, { "name" : "componentId", "in" : "path", "description" : "Vendor software product component Id", "required" : true, "type" : "string" }, { "name" : "computeFlavorId", "in" : "path", "description" : "Vendor software product compute-flavor 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}/versions/{versionId}/components/{componentId}/compute-flavors/{computeFlavorId}/questionnaire" : { "get" : { "tags" : [ "Vendor Software Product Component Compute-flavors" ], "summary" : "Get vendor software product component compute-flavor 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" : "versionId", "in" : "path", "description" : "Version Id", "required" : true, "type" : "string" }, { "name" : "componentId", "in" : "path", "description" : "Vendor software product component Id", "required" : true, "type" : "string" }, { "name" : "computeFlavorId", "in" : "path", "description" : "Vendor software product compute-flavor Id", "required" : true, "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 Compute-flavors" ], "summary" : "Update vendor software product component compute-flavor 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" : "versionId", "in" : "path", "description" : "Version Id", "required" : true, "type" : "string" }, { "name" : "componentId", "in" : "path", "description" : "Vendor software product component Id", "required" : true, "type" : "string" }, { "name" : "computeFlavorId", "in" : "path", "description" : "Vendor software product compute-flavor 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}/versions/{versionId}/components/{componentId}/images" : { "get" : { "tags" : [ "Vendor Software Product Images" ], "summary" : "List vendor software product component images", "description" : "", "operationId" : "list", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "vspId", "in" : "path", "description" : "Vendor software product Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Version 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" : { "type" : "array", "items" : { "$ref" : "#/definitions/ImageDto" } } } } }, "post" : { "tags" : [ "Vendor Software Product Images" ], "summary" : "Create a vendor software product component image", "description" : "", "operationId" : "create", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/ImageRequestDto" } }, { "name" : "vspId", "in" : "path", "description" : "Vendor software product Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Version 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}/versions/{versionId}/components/{componentId}/images/{imageId}" : { "get" : { "tags" : [ "Vendor Software Product Images" ], "summary" : "Get vendor software product component Image", "description" : "", "operationId" : "get", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "vspId", "in" : "path", "description" : "Vendor software product Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Version Id", "required" : true, "type" : "string" }, { "name" : "componentId", "in" : "path", "description" : "Vendor software product component Id", "required" : true, "type" : "string" }, { "name" : "imageId", "in" : "path", "description" : "Vendor software product Image Id", "required" : true, "type" : "string" }, { "name" : "USER_ID", "in" : "header", "required" : false, "type" : "string", "default" : "" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/ImageDto" } } } }, "put" : { "tags" : [ "Vendor Software Product Images" ], "summary" : "Update vendor software product Image", "description" : "", "operationId" : "update", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/ImageRequestDto" } }, { "name" : "vspId", "in" : "path", "description" : "Vendor software product Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Version Id", "required" : true, "type" : "string" }, { "name" : "componentId", "in" : "path", "description" : "Vendor software product component Id", "required" : true, "type" : "string" }, { "name" : "imageId", "in" : "path", "description" : "Vendor software product Image 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 Images" ], "summary" : "Delete vendor software product Image", "description" : "", "operationId" : "delete", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "vspId", "in" : "path", "description" : "Vendor software product Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Version Id", "required" : true, "type" : "string" }, { "name" : "componentId", "in" : "path", "description" : "Vendor software product component Id", "required" : true, "type" : "string" }, { "name" : "imageId", "in" : "path", "description" : "Vendor software product Image 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}/versions/{versionId}/components/{componentId}/images/{imageId}/questionnaire" : { "get" : { "tags" : [ "Vendor Software Product Images" ], "summary" : "Get vendor software product component image 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" : "versionId", "in" : "path", "description" : "Version Id", "required" : true, "type" : "string" }, { "name" : "componentId", "in" : "path", "description" : "Vendor software product component Id", "required" : true, "type" : "string" }, { "name" : "imageId", "in" : "path", "description" : "Vendor software product image Id", "required" : true, "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 Images" ], "summary" : "Update vendor software product component image 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" : "versionId", "in" : "path", "description" : "Version Id", "required" : true, "type" : "string" }, { "name" : "componentId", "in" : "path", "description" : "Vendor software product component Id", "required" : true, "type" : "string" }, { "name" : "imageId", "in" : "path", "description" : "Vendor software product image 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}/versions/{versionId}/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" : "versionId", "in" : "path", "description" : "Vendor software product version 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" : { "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" : "versionId", "in" : "path", "description" : "Vendor software product version 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}/versions/{versionId}/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" : "versionId", "in" : "path", "description" : "Vendor software product version 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" : { "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" : "versionId", "in" : "path", "description" : "Vendor software product version 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" : "versionId", "in" : "path", "description" : "Vendor software product version 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}/versions/{versionId}/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" : "versionId", "in" : "path", "description" : "Vendor software product version 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" : { "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" : "versionId", "in" : "path", "description" : "Vendor software product version 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}/versions/{versionId}/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" : "versionId", "in" : "path", "description" : "Vendor software product version 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" : { "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" : "versionId", "in" : "path", "description" : "Vendor software product version 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" : "versionId", "in" : "path", "description" : "Vendor software product version 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}/versions/{versionId}/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" : "versionId", "in" : "path", "description" : "Vendor software product version 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" : { "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" : "versionId", "in" : "path", "description" : "Vendor software product version 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" : "versionId", "in" : "path", "description" : "Vendor software product version 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}/versions/{versionId}/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" : "versionId", "in" : "path", "description" : "Vendor software product version 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" } } }, "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" : "versionId", "in" : "path", "description" : "Vendor software product version 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" : "versionId", "in" : "path", "description" : "Vendor software product version 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}/versions/{versionId}/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" : "versionId", "in" : "path", "description" : "Version 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/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" : "versionId", "in" : "path", "description" : "Version 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}/versions/{versionId}/components/{componentId}/uploads" : { "get" : { "tags" : [ "Vendor Software Product Component Uploads" ], "summary" : "Get the filenames of uploaded files by type", "description" : "", "operationId" : "list", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "vspId", "in" : "path", "description" : "Vendor software product Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Vendor software product version 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/MonitoringUploadStatusDto" } } } } }, "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId}/uploads/types/{type}" : { "post" : { "tags" : [ "Vendor Software Product Component Uploads" ], "summary" : "Upload file for component by type", "description" : "", "operationId" : "upload", "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" : "versionId", "in" : "path", "description" : "Vendor software product version Id", "required" : true, "type" : "string" }, { "name" : "componentId", "in" : "path", "description" : "Component Id", "required" : true, "type" : "string" }, { "name" : "type", "in" : "path", "description" : "Upload Type", "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 Uploads" ], "summary" : "Delete file uploaded for 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" : "versionId", "in" : "path", "description" : "Vendor software product version Id", "required" : true, "type" : "string" }, { "name" : "componentId", "in" : "path", "description" : "Component Id", "required" : true, "type" : "string" }, { "name" : "type", "in" : "path", "description" : "Upload Type", "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}/versions/{versionId}/compute-flavors" : { "get" : { "tags" : [ "Vendor Software Products" ], "summary" : "Get list of vendor software product compute-flavors", "description" : "", "operationId" : "listComputes", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "vspId", "in" : "path", "description" : "Vendor software product Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "required" : true, "type" : "string" }, { "name" : "USER_ID", "in" : "header", "required" : false, "type" : "string", "default" : "" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/VspComputeDto" } } } } } }, "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/deployment-flavors" : { "get" : { "tags" : [ "Vendor Software Product deployment-flavors" ], "summary" : "List vendor software product Deployment Flavor", "description" : "", "operationId" : "list", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "vspId", "in" : "path", "description" : "Vendor software product Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Version Id", "required" : true, "type" : "string" }, { "name" : "USER_ID", "in" : "header", "required" : false, "type" : "string", "default" : "" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/DeploymentFlavorListResponseDto" } } } } }, "post" : { "tags" : [ "Vendor Software Product deployment-flavors" ], "summary" : "Create a vendor software product Deployment Flavor", "description" : "", "operationId" : "create", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/DeploymentFlavorRequestDto" } }, { "name" : "vspId", "in" : "path", "description" : "Vendor software product Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Version 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}/versions/{versionId}/deployment-flavors/{deploymentFlavorId}" : { "get" : { "tags" : [ "Vendor Software Product deployment-flavors" ], "summary" : "Get vendor software product Deployment Flavor", "description" : "", "operationId" : "get", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "vspId", "in" : "path", "description" : "Vendor software product Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Version Id", "required" : true, "type" : "string" }, { "name" : "deploymentFlavorId", "in" : "path", "description" : "Vendor software product Deployment Flavor Id", "required" : true, "type" : "string" }, { "name" : "USER_ID", "in" : "header", "required" : false, "type" : "string", "default" : "" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/DeploymentFlavorDto" } } } }, "put" : { "tags" : [ "Vendor Software Product deployment-flavors" ], "summary" : "Update vendor software product Deployment Flavor", "description" : "", "operationId" : "update", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/DeploymentFlavorRequestDto" } }, { "name" : "vspId", "in" : "path", "description" : "Vendor software product Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Version Id", "required" : true, "type" : "string" }, { "name" : "deploymentFlavorId", "in" : "path", "description" : "Vendor software product Deployment Flavor 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 deployment-flavors" ], "summary" : "Delete vendor software product Deployment Flavor", "description" : "", "operationId" : "delete", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "vspId", "in" : "path", "description" : "Vendor software product Id", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Version Id", "required" : true, "type" : "string" }, { "name" : "deploymentFlavorId", "in" : "path", "description" : "Vendor software product Deployment Flavor 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}/versions/{versionId}/heal" : { "put" : { "tags" : [ "Vendor Software Products" ], "summary" : "Checkout and heal vendor software product questionnaire", "description" : "", "operationId" : "heal", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "vspId", "in" : "path", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "required" : true, "type" : "string" }, { "name" : "USER_ID", "in" : "header", "required" : false, "type" : "string", "default" : "" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/QuestionnaireResponseDto" } } } } }, "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/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" : "versionId", "in" : "path", "description" : "Version Id", "required" : true, "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" : "versionId", "in" : "path", "description" : "Version 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}/versions/{versionId}/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" : "versionId", "in" : "path", "description" : "Version 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" : { "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" : "versionId", "in" : "path", "description" : "Version 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" : "versionId", "in" : "path", "description" : "Version 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}/versions/{versionId}/orchestration-template" : { "get" : { "tags" : [ "Vendor Software Products" ], "summary" : "Get Orchestration Template (HEAT) file", "description" : "Downloads the latest HEAT package", "operationId" : "getOrchestrationTemplate", "consumes" : [ "application/json" ], "produces" : [ "application/octet-stream" ], "parameters" : [ { "name" : "vspId", "in" : "path", "required" : true, "type" : "string" }, { "name" : "versionId", "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}/versions/{versionId}/orchestration-template-candidate" : { "get" : { "tags" : [ "Orchestration Template Candidate" ], "summary" : "Get uploaded candidate HEAT file", "description" : "Downloads in process candidate HEAT file", "operationId" : "get", "consumes" : [ "application/json" ], "produces" : [ "application/octet-stream" ], "parameters" : [ { "name" : "vspId", "in" : "path", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Version Id", "required" : true, "type" : "string" }, { "name" : "USER_ID", "in" : "header", "required" : false, "type" : "string", "default" : "" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/File" } } } }, "post" : { "tags" : [ "Vendor Software Products" ], "summary" : "Uploads a HEAT package to translate", "description" : "", "operationId" : "uploadOrchestrationTemplateCandidate", "consumes" : [ "multipart/form-data" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "vspId", "in" : "path", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "required" : true, "type" : "string" }, { "name" : "upload", "in" : "formData", "required" : false, "type" : "file" }, { "name" : "USER_ID", "in" : "header", "required" : false, "type" : "string", "default" : "" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/UploadFileResponseDto" } } } }, "delete" : { "tags" : [ "Orchestration Template Candidate" ], "summary" : "Delete orchestration template candidate file and its files data structure", "description" : "", "operationId" : "abort", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "vspId", "in" : "path", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Version Id", "required" : true, "type" : "string" } ], "responses" : { "default" : { "description" : "successful operation" } } } }, "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/orchestration-template-candidate/manifest" : { "get" : { "tags" : [ "Orchestration Template Candidate" ], "summary" : "Get uploaded HEAT file files data structure", "description" : "Downloads the latest HEAT package", "operationId" : "getFilesDataStructure", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "vspId", "in" : "path", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Version Id", "required" : true, "type" : "string" }, { "name" : "USER_ID", "in" : "header", "required" : false, "type" : "string", "default" : "" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/FileDataStructureDto" } } } }, "put" : { "tags" : [ "Orchestration Template Candidate" ], "summary" : "Update an existing vendor software product", "description" : "", "operationId" : "updateFilesDataStructure", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "vspId", "in" : "path", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Version Id", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/FileDataStructureDto" } }, { "name" : "USER_ID", "in" : "header", "required" : false, "type" : "string", "default" : "" } ], "responses" : { "default" : { "description" : "successful operation" } } } }, "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/orchestration-template-candidate/process" : { "put" : { "tags" : [ "Orchestration Template Candidate" ], "summary" : "process Orchestration Template Candidate", "description" : "", "operationId" : "process", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "vspId", "in" : "path", "required" : true, "type" : "string" }, { "name" : "versionId", "in" : "path", "description" : "Version Id", "required" : true, "type" : "string" }, { "name" : "USER_ID", "in" : "header", "required" : false, "type" : "string", "default" : "" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/UploadFileResponseDto" } } } } }, "/v1.0/vendor-software-products/{vspId}/versions/{versionId}/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" : "versionId", "in" : "path", "description" : "Vendor software product version Id", "required" : true, "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" : "versionId", "in" : "path", "description" : "Vendor software product version 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" : "versionId", "in" : "path", "description" : "Vendor software product version 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}/versions/{versionId}/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" : "versionId", "in" : "path", "description" : "Vendor software product version 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" : { "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" : "versionId", "in" : "path", "description" : "Vendor software product version 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" : "versionId", "in" : "path", "description" : "Vendor software product version 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}/versions/{versionId}/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" : "versionId", "in" : "path", "description" : "Vendor software product version 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" } } }, "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" : "versionId", "in" : "path", "description" : "Vendor software product version 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" : "versionId", "in" : "path", "description" : "Vendor software product version 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}/versions/{versionId}/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" : "versionId", "in" : "path", "required" : true, "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" : "versionId", "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}/versions/{versionId}/vspInformationArtifact" : { "get" : { "tags" : [ "Vendor Software Products" ], "summary" : "Get vendor software product information artifact for specified version", "description" : "", "operationId" : "getVspInformationArtifact", "consumes" : [ "application/json" ], "produces" : [ "text/plain" ], "parameters" : [ { "name" : "vspId", "in" : "path", "required" : true, "type" : "string" }, { "name" : "versionId", "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" } } } } }, "/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 OPENECOMP Components supported by Action Library", "description" : "", "operationId" : "getOpenEcompComponents", "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" : "" }, { "name" : "uploadArtifact", "in" : "formData", "required" : false, "type" : "file" } ], "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" : "" }, { "name" : "updateArtifact", "in" : "formData", "required" : false, "type" : "file" } ], "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" : { "ActivityLogDto" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "timestamp" : { "type" : "string", "format" : "date-time" }, "type" : { "type" : "string" }, "comment" : { "type" : "string" }, "user" : { "type" : "string" }, "status" : { "$ref" : "#/definitions/ActivityStatus" } } }, "ActivityStatus" : { "type" : "object", "properties" : { "success" : { "type" : "boolean", "default" : false }, "message" : { "type" : "string" } } }, "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" } } }, "ChoiceOrOtherDtoLicenseTerm" : { "type" : "object", "required" : [ "choice", "other" ], "properties" : { "choice" : { "type" : "string", "enum" : [ "Fixed_Term", "Perpetual", "Unlimited", "Other" ] }, "other" : { "type" : "string" } } }, "CommandInfo" : { "type" : "object", "properties" : { "commandName" : { "type" : "string" }, "commandClass" : { "type" : "string" } } }, "CommitRequestDto" : { "type" : "object", "properties" : { "message" : { "type" : "string" } } }, "ComponentComputeAssociation" : { "type" : "object", "properties" : { "componentId" : { "type" : "string" }, "computeFlavorId" : { "type" : "string" } } }, "ComponentData" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "vfcCode" : { "type" : "string" }, "nfcCode" : { "type" : "string" }, "nfcFunction" : { "type" : "string" } } }, "ComponentDependencyModel" : { "type" : "object", "properties" : { "sourceId" : { "type" : "string" }, "targetId" : { "type" : "string" }, "relationType" : { "type" : "string" } } }, "ComponentDependencyResponseDto" : { "type" : "object", "properties" : { "sourceId" : { "type" : "string" }, "targetId" : { "type" : "string" }, "relationType" : { "type" : "string" }, "id" : { "type" : "string" } } }, "ComponentDto" : { "type" : "object", "required" : [ "displayName" ], "properties" : { "name" : { "type" : "string" }, "displayName" : { "type" : "string", "minLength" : 1, "maxLength" : 30 }, "vfcCode" : { "type" : "string", "minLength" : 0, "maxLength" : 1000 }, "nfcCode" : { "type" : "string" }, "nfcFunction" : { "type" : "string" }, "description" : { "type" : "string" }, "id" : { "type" : "string" } } }, "ComponentRequestDto" : { "type" : "object", "required" : [ "displayName" ], "properties" : { "name" : { "type" : "string" }, "displayName" : { "type" : "string", "minLength" : 1, "maxLength" : 30 }, "vfcCode" : { "type" : "string", "minLength" : 0, "maxLength" : 1000 }, "nfcCode" : { "type" : "string" }, "nfcFunction" : { "type" : "string" }, "description" : { "type" : "string" } } }, "ComputeDetailsDto" : { "type" : "object", "properties" : { "name" : { "type" : "string", "minLength" : 0, "maxLength" : 30 }, "description" : { "type" : "string", "minLength" : 0, "maxLength" : 300 } } }, "ComputeDto" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "id" : { "type" : "string" }, "description" : { "type" : "string" }, "associatedToDeploymentFlavor" : { "type" : "boolean", "default" : false } } }, "ConfigurationDataDto" : { "type" : "object", "properties" : { "value" : { "type" : "string" }, "timeStamp" : { "type" : "integer", "format" : "int64" } } }, "ConflictDto" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "itemVersion", "VendorLicenseModel", "LicenseAgreements", "LicenseAgreement", "FeatureGroups", "FeatureGroup", "LicenseKeyGroups", "LicenseKeyGroup", "EntitlementPools", "EntitlementPool", "Limits", "Limit", "VendorSoftwareProduct", "VSPQuestionnaire", "VspModel", "NetworkPackage", "OrchestrationTemplateCandidate", "OrchestrationTemplateCandidateContent", "OrchestrationTemplateCandidateValidationData", "OrchestrationTemplateStructure", "OrchestrationTemplate", "OrchestrationTemplateValidationData", "OrchestrationTemplateContent", "Networks", "Network", "Components", "Component", "ComponentQuestionnaire", "ComponentDependencies", "ComponentDependency", "Nics", "Nic", "NicQuestionnaire", "Mibs", "SNMP_POLL", "SNMP_TRAP", "VES_EVENTS", "Processes", "Process", "DeploymentFlavors", "DeploymentFlavor", "Computes", "Compute", "ComputeQuestionnaire", "Images", "Image", "ImageQuestionnaire", "ServiceModel", "EnrichedServiceModel", "ServiceTemplate", "Templates", "Artifact", "Artifacts", "test" ] }, "name" : { "type" : "string" }, "yours" : { "type" : "object", "additionalProperties" : { "type" : "object" } }, "theirs" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } }, "ConflictInfoDto" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "itemVersion", "VendorLicenseModel", "LicenseAgreements", "LicenseAgreement", "FeatureGroups", "FeatureGroup", "LicenseKeyGroups", "LicenseKeyGroup", "EntitlementPools", "EntitlementPool", "Limits", "Limit", "VendorSoftwareProduct", "VSPQuestionnaire", "VspModel", "NetworkPackage", "OrchestrationTemplateCandidate", "OrchestrationTemplateCandidateContent", "OrchestrationTemplateCandidateValidationData", "OrchestrationTemplateStructure", "OrchestrationTemplate", "OrchestrationTemplateValidationData", "OrchestrationTemplateContent", "Networks", "Network", "Components", "Component", "ComponentQuestionnaire", "ComponentDependencies", "ComponentDependency", "Nics", "Nic", "NicQuestionnaire", "Mibs", "SNMP_POLL", "SNMP_TRAP", "VES_EVENTS", "Processes", "Process", "DeploymentFlavors", "DeploymentFlavor", "Computes", "Compute", "ComputeQuestionnaire", "Images", "Image", "ImageQuestionnaire", "ServiceModel", "EnrichedServiceModel", "ServiceTemplate", "Templates", "Artifact", "Artifacts", "test" ] }, "name" : { "type" : "string" } } }, "ConflictResolutionDto" : { "type" : "object", "properties" : { "resolution" : { "type" : "string", "enum" : [ "THEIRS", "YOURS", "OTHER" ] }, "otherResolution" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } }, "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" }, "primaryType" : { "type" : "string" }, "mimeTypeSerializedObject" : { "type" : "boolean", "default" : false }, "defaultRepresentationClassAsString" : { "type" : "string" }, "representationClassInputStream" : { "type" : "boolean", "default" : false }, "representationClassReader" : { "type" : "boolean", "default" : false }, "representationClassCharBuffer" : { "type" : "boolean", "default" : false }, "representationClassByteBuffer" : { "type" : "boolean", "default" : false }, "representationClassSerializable" : { "type" : "boolean", "default" : false }, "representationClassRemote" : { "type" : "boolean", "default" : false }, "flavorSerializedObjectType" : { "type" : "boolean", "default" : false }, "flavorRemoteObjectType" : { "type" : "boolean", "default" : false }, "flavorJavaFileListType" : { "type" : "boolean", "default" : false }, "flavorTextType" : { "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" }, "transferDataFlavors" : { "type" : "array", "items" : { "$ref" : "#/definitions/DataFlavor" } }, "preferredCommands" : { "type" : "array", "items" : { "$ref" : "#/definitions/CommandInfo" } }, "allCommands" : { "type" : "array", "items" : { "$ref" : "#/definitions/CommandInfo" } } } }, "DataSource" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "inputStream" : { "$ref" : "#/definitions/InputStream" }, "contentType" : { "type" : "string" }, "outputStream" : { "$ref" : "#/definitions/OutputStream" } } }, "DeploymentFlavorDto" : { "type" : "object", "properties" : { "model" : { "type" : "string", "minLength" : 0, "maxLength" : 30 }, "description" : { "type" : "string", "minLength" : 0, "maxLength" : 300 }, "featureGroupId" : { "type" : "string" }, "componentComputeAssociations" : { "type" : "array", "items" : { "$ref" : "#/definitions/ComponentComputeAssociation" } }, "id" : { "type" : "string" } } }, "DeploymentFlavorListResponseDto" : { "type" : "object", "properties" : { "model" : { "type" : "string" }, "description" : { "type" : "string" }, "id" : { "type" : "string" } } }, "DeploymentFlavorRequestDto" : { "type" : "object", "properties" : { "model" : { "type" : "string", "minLength" : 0, "maxLength" : 30 }, "description" : { "type" : "string", "minLength" : 0, "maxLength" : 300 }, "featureGroupId" : { "type" : "string" }, "componentComputeAssociations" : { "type" : "array", "items" : { "$ref" : "#/definitions/ComponentComputeAssociation" } } } }, "EntitlementPoolEntity" : { "type" : "object", "required" : [ "name" ], "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" ] }, "increments" : { "type" : "string", "minLength" : 0, "maxLength" : 120 }, "operationalScope" : { "$ref" : "#/definitions/MultiChoiceOrOtherDtoOperationalScope" }, "startDate" : { "type" : "string" }, "expiryDate" : { "type" : "string" }, "id" : { "type" : "string" }, "referencingFeatureGroups" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } } } }, "EntitlementPoolRequest" : { "type" : "object", "required" : [ "name" ], "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" ] }, "increments" : { "type" : "string", "minLength" : 0, "maxLength" : 120 }, "operationalScope" : { "$ref" : "#/definitions/MultiChoiceOrOtherDtoOperationalScope" }, "startDate" : { "type" : "string" }, "expiryDate" : { "type" : "string" } } }, "ErrorMessage" : { "type" : "object", "properties" : { "level" : { "type" : "string", "enum" : [ "ERROR", "WARNING", "INFO" ] }, "message" : { "type" : "string" } } }, "FeatureGroupEntity" : { "type" : "object", "required" : [ "name", "partNumber" ], "properties" : { "name" : { "type" : "string", "minLength" : 0, "maxLength" : 120 }, "description" : { "type" : "string", "minLength" : 0, "maxLength" : 1000 }, "partNumber" : { "type" : "string" }, "manufacturerReferenceNumber" : { "type" : "string", "minLength" : 0, "maxLength" : 100 }, "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" : [ "name", "partNumber" ], "properties" : { "name" : { "type" : "string", "minLength" : 0, "maxLength" : 120 }, "description" : { "type" : "string", "minLength" : 0, "maxLength" : 1000 }, "partNumber" : { "type" : "string" }, "manufacturerReferenceNumber" : { "type" : "string", "minLength" : 0, "maxLength" : 100 }, "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" : [ "name", "partNumber" ], "properties" : { "name" : { "type" : "string", "minLength" : 0, "maxLength" : 120 }, "description" : { "type" : "string", "minLength" : 0, "maxLength" : 1000 }, "partNumber" : { "type" : "string" }, "manufacturerReferenceNumber" : { "type" : "string", "minLength" : 0, "maxLength" : 100 }, "addedLicenseKeyGroupsIds" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "addedEntitlementPoolsIds" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } } } }, "FeatureGroupUpdateRequest" : { "type" : "object", "required" : [ "name", "partNumber" ], "properties" : { "name" : { "type" : "string", "minLength" : 0, "maxLength" : 120 }, "description" : { "type" : "string", "minLength" : 0, "maxLength" : 1000 }, "partNumber" : { "type" : "string" }, "manufacturerReferenceNumber" : { "type" : "string", "minLength" : 0, "maxLength" : 100 }, "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" }, "parent" : { "type" : "string" }, "absolute" : { "type" : "boolean", "default" : false }, "canonicalPath" : { "type" : "string" }, "parentFile" : { "$ref" : "#/definitions/File" }, "absolutePath" : { "type" : "string" }, "absoluteFile" : { "$ref" : "#/definitions/File" }, "canonicalFile" : { "$ref" : "#/definitions/File" }, "directory" : { "type" : "boolean", "default" : false }, "file" : { "type" : "boolean", "default" : false }, "hidden" : { "type" : "boolean", "default" : false }, "totalSpace" : { "type" : "integer", "format" : "int64" }, "freeSpace" : { "type" : "integer", "format" : "int64" }, "usableSpace" : { "type" : "integer", "format" : "int64" } } }, "FileDataStructureDto" : { "type" : "object", "properties" : { "modules" : { "type" : "array", "items" : { "$ref" : "#/definitions/Module" } }, "unassigned" : { "type" : "array", "items" : { "type" : "string" } }, "artifacts" : { "type" : "array", "items" : { "type" : "string" } }, "nested" : { "type" : "array", "items" : { "type" : "string" } } } }, "HealthInfoDto" : { "type" : "object", "properties" : { "healthCheckComponent" : { "type" : "string", "enum" : [ "BE", "CAS", "ZU" ] }, "healthStatus" : { "type" : "string", "enum" : [ "UP", "DOWN" ] }, "version" : { "type" : "string" }, "description" : { "type" : "string" } } }, "HealthInfoDtos" : { "type" : "object", "properties" : { "healthInfos" : { "type" : "array", "items" : { "$ref" : "#/definitions/HealthInfoDto" } } } }, "ImageDto" : { "type" : "object", "properties" : { "fileName" : { "type" : "string" }, "description" : { "type" : "string" }, "id" : { "type" : "string" } } }, "ImageRequestDto" : { "type" : "object", "properties" : { "fileName" : { "type" : "string" }, "description" : { "type" : "string" } } }, "InputStream" : { "type" : "object" }, "ItemCreationDto" : { "type" : "object", "properties" : { "itemId" : { "type" : "string" }, "version" : { "$ref" : "#/definitions/VersionDto" } } }, "ItemDto" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "type" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "owner" : { "type" : "string" } } }, "ItemPermissionsDto" : { "type" : "object", "properties" : { "userId" : { "type" : "string" }, "permission" : { "type" : "string" } } }, "ItemPermissionsRequest" : { "type" : "object", "properties" : { "addedUsersIds" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "removedUsersIds" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } } } }, "ItemVersionConflictDto" : { "type" : "object", "properties" : { "conflict" : { "$ref" : "#/definitions/ConflictDto" }, "conflictInfoList" : { "type" : "array", "items" : { "$ref" : "#/definitions/ConflictInfoDto" } } } }, "LicenseAgreementEntity" : { "type" : "object", "required" : [ "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" : [ "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" : [ "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" : [ "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" : [ "name", "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" }, "startDate" : { "type" : "string" }, "expiryDate" : { "type" : "string" }, "thresholdValue" : { "type" : "integer", "format" : "int32" }, "thresholdUnits" : { "type" : "string", "enum" : [ "Absolute", "Percentage" ] }, "increments" : { "type" : "string", "minLength" : 0, "maxLength" : 120 }, "id" : { "type" : "string" }, "referencingFeatureGroups" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } } } }, "LicenseKeyGroupRequestDto" : { "type" : "object", "required" : [ "name", "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" }, "startDate" : { "type" : "string" }, "expiryDate" : { "type" : "string" }, "thresholdValue" : { "type" : "integer", "format" : "int32" }, "thresholdUnits" : { "type" : "string", "enum" : [ "Absolute", "Percentage" ] }, "increments" : { "type" : "string", "minLength" : 0, "maxLength" : 120 } } }, "LicensingData" : { "type" : "object", "properties" : { "licenseAgreement" : { "type" : "string" }, "featureGroups" : { "type" : "array", "items" : { "type" : "string" } } } }, "LimitEntityDto" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "type" : { "type" : "string" }, "description" : { "type" : "string" }, "metric" : { "type" : "string" }, "value" : { "type" : "string" }, "unit" : { "type" : "string" }, "aggregationFunction" : { "type" : "string" }, "time" : { "type" : "string" } } }, "LimitRequest" : { "type" : "object", "properties" : { "name" : { "type" : "string", "minLength" : 0, "maxLength" : 120 }, "type" : { "type" : "string" }, "description" : { "type" : "string", "minLength" : 0, "maxLength" : 1000 }, "metric" : { "type" : "string" }, "value" : { "type" : "string" }, "unit" : { "type" : "string" }, "aggregationFunction" : { "type" : "string" }, "time" : { "type" : "string" } } }, "MediaType" : { "type" : "object", "properties" : { "type" : { "type" : "string" }, "subtype" : { "type" : "string" }, "parameters" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "wildcardType" : { "type" : "boolean", "default" : false }, "wildcardSubtype" : { "type" : "boolean", "default" : false } } }, "Module" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "isBase" : { "type" : "boolean", "default" : false }, "yaml" : { "type" : "string" }, "env" : { "type" : "string" }, "vol" : { "type" : "string" }, "volEnv" : { "type" : "string" } } }, "MonitoringUploadStatusDto" : { "type" : "object", "properties" : { "snmpTrap" : { "type" : "string" }, "snmpPoll" : { "type" : "string" }, "vesEvent" : { "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", "required" : [ "networkType" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "networkId" : { "type" : "string" }, "networkType" : { "type" : "string" }, "networkDescription" : { "type" : "string" }, "id" : { "type" : "string" }, "networkName" : { "type" : "string" } } }, "NicRequestDto" : { "type" : "object", "required" : [ "networkType" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "networkId" : { "type" : "string" }, "networkType" : { "type" : "string" }, "networkDescription" : { "type" : "string" } } }, "NotificationEntityDto" : { "type" : "object", "properties" : { "read" : { "type" : "boolean", "default" : false }, "eventId" : { "type" : "string", "format" : "uuid" }, "dateTime" : { "type" : "string" }, "eventType" : { "type" : "string" }, "eventAttributes" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } }, "NotificationsStatusDto" : { "type" : "object", "properties" : { "notifications" : { "type" : "array", "items" : { "$ref" : "#/definitions/NotificationEntityDto" } }, "newEntries" : { "type" : "array", "items" : { "type" : "string", "format" : "uuid" } }, "lastScanned" : { "type" : "string", "format" : "uuid" }, "endOfPage" : { "type" : "string", "format" : "uuid" }, "numOfNotSeenNotifications" : { "type" : "integer", "format" : "int64" } } }, "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" }, "type" : { "type" : "string", "enum" : [ "Lifecycle_Operations", "Other" ] }, "id" : { "type" : "string" }, "artifactName" : { "type" : "string" } } }, "ProcessRequestDto" : { "type" : "object", "required" : [ "name" ], "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "Lifecycle_Operations", "Other" ] } } }, "QuestionnaireResponseDto" : { "type" : "object", "properties" : { "schema" : { "type" : "string" }, "data" : { "type" : "string" }, "errorMessage" : { "$ref" : "#/definitions/ErrorMessage" } } }, "RevisionDto" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "message" : { "type" : "string" }, "time" : { "type" : "string", "format" : "date-time" }, "user" : { "type" : "string" } } }, "RevisionRequestDto" : { "type" : "object", "properties" : { "revisionId" : { "type" : "string" } } }, "SubmitRequestDto" : { "type" : "object", "properties" : { "message" : { "type" : "string" } } }, "UpdateNotificationResponseStatus" : { "type" : "object", "properties" : { "errors" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/definitions/ErrorMessage" } } }, "status" : { "type" : "string", "enum" : [ "Success", "Failure" ] } } }, "UploadFileResponseDto" : { "type" : "object", "properties" : { "errors" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/definitions/ErrorMessage" } } }, "status" : { "type" : "string", "enum" : [ "Success", "Failure" ] }, "onboardingOrigin" : { "type" : "string" }, "networkPackageName" : { "type" : "string" } } }, "VendorLicenseModelActionRequestDto" : { "type" : "object", "properties" : { "action" : { "type" : "string", "enum" : [ "Submit" ] }, "submitRequest" : { "$ref" : "#/definitions/SubmitRequestDto" } } }, "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" } } }, "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" } } }, "VersionActionRequestDto" : { "type" : "object", "properties" : { "action" : { "type" : "string", "enum" : [ "Sync", "Commit", "Revert", "Reset" ] }, "commitRequest" : { "$ref" : "#/definitions/CommitRequestDto" }, "revisionRequest" : { "$ref" : "#/definitions/RevisionRequestDto" } } }, "VersionDto" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "baseId" : { "type" : "string" }, "status" : { "type" : "string", "enum" : [ "Draft", "Locked", "Certified" ] }, "state" : { "$ref" : "#/definitions/VersionState" }, "creationTime" : { "type" : "string", "format" : "date-time" }, "modificationTime" : { "type" : "string", "format" : "date-time" }, "additionalInfo" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } }, "VersionRequestDto" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "creationMethod" : { "type" : "string", "enum" : [ "major", "minor" ] } } }, "VersionSoftwareProductActionRequestDto" : { "type" : "object", "properties" : { "action" : { "type" : "string", "enum" : [ "Submit", "Create_Package" ] }, "submitRequest" : { "$ref" : "#/definitions/SubmitRequestDto" } } }, "VersionState" : { "type" : "object", "properties" : { "synchronizationState" : { "type" : "string", "enum" : [ "UpToDate", "OutOfSync", "Merging" ] }, "dirty" : { "type" : "boolean", "default" : false } } }, "VspComputeDto" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "componentId" : { "type" : "string" }, "computeFlavorId" : { "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" } } }, "VspRequestDto" : { "type" : "object", "required" : [ "category", "description", "name", "onboardingMethod", "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" }, "onboardingMethod" : { "type" : "string" } } } } }