openapi: 3.0.0 info: title: onap_sdc contact: {} version: '1.2.0' servers: - url: https://{defaultHost} variables: defaultHost: default: www.example.com/sdc paths: /v1/catalog/services/{serviceName}/{serviceVersion}/artifacts/{artifactName}: get: tags: - Distribution Catalog Servlet summary: downloadServiceArtifact description: Returns downloaded artifact operationId: downloadServiceArtifact parameters: - name: X-ECOMP-RequestID in: header description: X-ECOMP-RequestID header style: simple schema: type: string - name: X-ECOMP-InstanceID in: header description: X-ECOMP-InstanceID header required: true style: simple schema: type: string - name: Accept in: header description: Determines the format of the body of the response style: simple schema: type: string - name: Authorization in: header description: The username and password required: true style: simple schema: type: string - name: serviceName in: path description: '' required: true style: simple schema: type: string - name: serviceVersion in: path description: '' required: true style: simple schema: type: string - name: artifactName in: path description: '' required: true style: simple schema: type: string responses: '200': description: The artifact is found and streamed. headers: {} content: application/octet-stream: schema: type: string description: The artifact is found and streamed. format: binary '400': description: Missing 'X-ECOMP-InstanceID' HTTP header - POL5001 headers: {} content: {} '401': description: ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002 headers: {} content: {} '403': description: ECOMP component is not authorized - POL5003 headers: {} content: {} '404': description: Specified artifact is not found - SVC4505 headers: {} content: {} '405': description: 'Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050' headers: {} content: {} '500': description: The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000 headers: {} content: {} deprecated: false /v1/catalog/services/{serviceName}/{serviceVersion}/resourceInstances/{resourceInstanceName}/artifacts/{artifactName}: get: tags: - Distribution Catalog Servlet summary: downloadResourceInstanceArtifactByName description: Returns downloaded artifact operationId: downloadResourceInstanceArtifactByName parameters: - name: X-ECOMP-RequestID in: header description: X-ECOMP-RequestID header style: simple schema: type: string - name: X-ECOMP-InstanceID in: header description: X-ECOMP-InstanceID header required: true style: simple schema: type: string - name: Accept in: header description: Determines the format of the body of the response style: simple schema: type: string - name: Authorization in: header description: The username and password required: true style: simple schema: type: string - name: serviceName in: path description: '' required: true style: simple schema: type: string - name: serviceVersion in: path description: '' required: true style: simple schema: type: string - name: resourceInstanceName in: path description: '' required: true style: simple schema: type: string - name: artifactName in: path description: '' required: true style: simple schema: type: string responses: '200': description: The artifact is found and streamed. headers: {} content: application/octet-stream: schema: type: string description: The artifact is found and streamed. format: binary '400': description: Missing 'X-ECOMP-InstanceID' HTTP header - POL5001 headers: {} content: {} '401': description: ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002 headers: {} content: {} '403': description: ECOMP component is not authorized - POL5003 headers: {} content: {} '404': description: Specified artifact is not found - SVC4505 headers: {} content: {} '405': description: 'Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050' headers: {} content: {} '500': description: The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000 headers: {} content: {} deprecated: false /v1/catalog/services/{serviceName}/{serviceVersion}/resources/{resourceName}/{resourceVersion}/artifacts/{artifactName}: get: tags: - Distribution Catalog Servlet summary: downloadResourceArtifact description: Returns downloaded artifact operationId: downloadResourceArtifact parameters: - name: X-ECOMP-RequestID in: header description: X-ECOMP-RequestID header style: simple schema: type: string - name: X-ECOMP-InstanceID in: header description: X-ECOMP-InstanceID header required: true style: simple schema: type: string - name: Accept in: header description: Determines the format of the body of the response style: simple schema: type: string - name: Authorization in: header description: The username and password required: true style: simple schema: type: string - name: serviceName in: path description: '' required: true style: simple schema: type: string - name: serviceVersion in: path description: '' required: true style: simple schema: type: string - name: resourceName in: path description: '' required: true style: simple schema: type: string - name: resourceVersion in: path description: '' required: true style: simple schema: type: string - name: artifactName in: path description: '' required: true style: simple schema: type: string responses: '200': description: The artifact is found and streamed. headers: {} content: application/octet-stream: schema: type: string description: The artifact is found and streamed. format: binary '400': description: Missing 'X-ECOMP-InstanceID' HTTP header - POL5001 headers: {} content: {} '401': description: ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002 headers: {} content: {} '403': description: ECOMP component is not authorized - POL5003 headers: {} content: {} '404': description: Specified artifact is not found - SVC4505 headers: {} content: {} '405': description: 'Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050' headers: {} content: {} '500': description: The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000 headers: {} content: {} deprecated: false /v1/registerForDistribution: post: tags: - Distribution Servlet summary: registerForDistribution description: Subscribes for distribution notifications operationId: registerForDistribution parameters: - name: X-ECOMP-RequestID in: header description: X-ECOMP-RequestID header style: simple schema: type: string - name: X-ECOMP-InstanceID in: header description: X-ECOMP-InstanceID header required: true style: simple schema: type: string - name: Accept in: header description: Determines the format of the body of the response style: simple schema: type: string - name: Content-Length in: header description: Length of the request body required: true style: simple schema: type: string - name: Authorization in: header description: The username and password required: true style: simple schema: type: string requestBody: description: json describe the artifact content: application/json: schema: allOf: - $ref: '#/components/schemas/RegistrationRequest' - description: json describe the artifact required: true responses: '200': description: ECOMP component is successfully registered for distribution headers: {} content: application/json: schema: $ref: '#/components/schemas/TopicRegistrationResponse' '400': description: "Invalid Body : Specified 'distrEnvName' doesn’t exist - POL4137" headers: {} content: {} '401': description: ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002 headers: {} content: {} '403': description: ECOMP component is not authorized - POL5003 headers: {} content: {} '405': description: 'Method Not Allowed : Invalid HTTP method type used to register for distribution ( PUT,DELETE,GET will be rejected) - POL4050' headers: {} content: {} '500': description: The registration failed due to internal SDC problem or Cambria Service failure ECOMP Component should continue the attempts to register for distribution - POL5000 headers: {} content: {} deprecated: false /v1/artifactTypes: get: tags: - Distribution Servlet summary: getValidArtifactTypes description: Fetches available artifact types list operationId: getValidArtifactTypes parameters: - name: X-ECOMP-RequestID in: header description: X-ECOMP-RequestID header style: simple schema: type: string - name: X-ECOMP-InstanceID in: header description: X-ECOMP-InstanceID header required: true style: simple schema: type: string - name: Authorization in: header description: The username and password required: true style: simple schema: type: string - name: Accept in: header description: The username and password required: true style: simple schema: type: string responses: '200': description: Artifact types list fetched successfully headers: {} content: application/json: schema: type: string description: Artifact types list fetched successfully '400': description: Missing 'X-ECOMP-InstanceID' HTTP header - POL5001 headers: {} content: {} '401': description: ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002 headers: {} content: {} '403': description: ECOMP component is not authorized - POL5003 headers: {} content: {} '405': description: 'Method Not Allowed : Invalid HTTP method type used to register for distribution ( POST,PUT,DELETE will be rejected) - POL4050' headers: {} content: {} '500': description: The registration failed due to internal SDC problem or Cambria Service failure ECOMP Component should continue the attempts to register for distribution - POL5000 headers: {} content: {} deprecated: false /v1/unRegisterForDistribution: post: tags: - Distribution Servlet summary: unRegisterForDistribution description: Removes from subscription for distribution notifications operationId: unRegisterForDistribution parameters: - name: X-ECOMP-RequestID in: header description: X-ECOMP-RequestID header style: simple schema: type: string - name: X-ECOMP-InstanceID in: header description: X-ECOMP-InstanceID header required: true style: simple schema: type: string - name: Accept in: header description: Determines the format of the body of the response style: simple schema: type: string - name: Content-Length in: header description: Length of the request body required: true style: simple schema: type: string - name: Authorization in: header description: The username and password required: true style: simple schema: type: string requestBody: description: json describe the artifact content: application/json: schema: allOf: - $ref: '#/components/schemas/RegistrationRequest' - description: json describe the artifact required: true responses: '204': description: ECOMP component is successfully unregistered headers: {} content: application/json: schema: $ref: '#/components/schemas/TopicUnregistrationResponse' '400': description: "Invalid Body : Specified 'distrEnvName' doesn’t exist - POL4137" headers: {} content: {} '401': description: ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002 headers: {} content: {} '403': description: ECOMP component is not authorized - POL5003 headers: {} content: {} '405': description: 'Method Not Allowed : Invalid HTTP method type used to register for distribution ( PUT,DELETE,GET will be rejected) - POL4050' headers: {} content: {} '500': description: The registration failed due to internal SDC problem or Cambria Service failure ECOMP Component should continue the attempts to register for distribution - POL5000 headers: {} content: {} deprecated: false /v1/distributionUebCluster: get: tags: - Distribution Servlet summary: getUebServerList description: return the available UEB Server List operationId: getUebServerList parameters: - name: X-ECOMP-RequestID in: header description: X-ECOMP-RequestID header style: simple schema: type: string - name: X-ECOMP-InstanceID in: header description: X-ECOMP-InstanceID header required: true style: simple schema: type: string - name: Accept in: header description: Determines the format of the body of the response style: simple schema: type: string - name: Authorization in: header description: The username and password required: true style: simple schema: type: string responses: '200': description: ECOMP component is authenticated and list of Cambria API server’s FQDNs is returned headers: {} content: application/json: schema: $ref: '#/components/schemas/ServerListResponse' '400': description: Missing 'X-ECOMP-InstanceID' HTTP header - POL5001 headers: {} content: {} '401': description: ECOMP component should authenticate itself and to re-send again HTTP request with its credentials for Basic Authentication - POL5002 headers: {} content: {} '403': description: ECOMP component is not authorized - POL5003 headers: {} content: {} '405': description: 'Method Not Allowed: Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050' headers: {} content: {} '500': description: The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000 headers: {} content: {} deprecated: false /v1/catalog/{assetType}/{uuid}/artifacts: post: tags: - Artifact External Servlet summary: uploadArtifact description: uploads of artifact to a resource or service operationId: uploadArtifact parameters: - name: Content-MD5 in: header description: The value for this header must be the MD5 checksum over the whole json body required: true style: simple schema: type: string - name: USER_ID in: header description: The user ID of the DCAE Designer. This user must also have Designer role in SDC required: true style: simple schema: type: string - name: X-ECOMP-RequestID in: header description: X-ECOMP-RequestID header style: simple schema: type: string - name: X-ECOMP-InstanceID in: header description: X-ECOMP-InstanceID header required: true style: simple schema: type: string - name: Accept in: header description: Determines the format of the body of the response style: simple schema: type: string - name: Authorization in: header description: The username and password required: true style: simple schema: type: string - name: assetType in: path description: The requested asset type required: true style: simple schema: allOf: - $ref: '#/components/schemas/assetType' - description: The requested asset type - name: uuid in: path description: The uuid of the asset as published in the metadata required: true style: simple schema: type: string requestBody: description: json describe the artifact content: application/json: schema: allOf: - $ref: '#/components/schemas/ArtifactDefinition' - description: json describe the artifact required: true responses: '200': description: Artifact uploaded headers: {} content: application/json: schema: $ref: '#/components/schemas/ArtifactDefinition' '400': description: Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301 headers: {} content: {} '401': description: ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002 headers: {} content: {} '403': description: ECOMP component is not authorized - POL5003 headers: {} content: {} '404': description: Specified resource is not found - SVC4063 headers: {} content: {} '405': description: 'Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050' headers: {} content: {} '500': description: The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000 headers: {} content: {} deprecated: false /v1/catalog/{assetType}/{uuid}/artifacts/{artifactUUID}: get: tags: - Artifact External Servlet summary: downloadComponentArtifact description: Returns downloaded artifact operationId: downloadComponentArtifact parameters: - name: USER_ID in: header description: The user ID of the DCAE Designer. This user must also have Designer role in SDC required: true style: simple schema: type: string - name: X-ECOMP-RequestID in: header description: X-ECOMP-RequestID header style: simple schema: type: string - name: X-ECOMP-InstanceID in: header description: X-ECOMP-InstanceID header required: true style: simple schema: type: string - name: Accept in: header description: Determines the format of the body of the response style: simple schema: type: string - name: Authorization in: header description: The username and password required: true style: simple schema: type: string - name: assetType in: path description: The requested asset type required: true style: simple schema: allOf: - $ref: '#/components/schemas/assetType' - description: The requested asset type - name: uuid in: path description: The uuid of the asset as published in the metadata required: true style: simple schema: type: string - name: artifactUUID in: path description: The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation required: true style: simple schema: type: string responses: '200': description: Artifact downloaded headers: {} content: application/octet-stream: schema: type: string description: Artifact downloaded format: binary '400': description: Missing 'X-ECOMP-InstanceID' HTTP header - POL5001 headers: {} content: {} '401': description: ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002 headers: {} content: {} '403': description: ECOMP component is not authorized - POL5003 headers: {} content: {} '404': description: Artifact was not found - SVC4505 headers: {} content: {} '405': description: 'Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050' headers: {} content: {} '500': description: The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000 headers: {} content: {} deprecated: false post: tags: - Artifact External Servlet summary: updateArtifact description: uploads of artifact to a resource or service operationId: updateArtifact parameters: - name: Content-MD5 in: header description: The value for this header must be the MD5 checksum over the whole json body required: true style: simple schema: type: string - name: USER_ID in: header description: The user ID of the DCAE Designer. This user must also have Designer role in SDC required: true style: simple schema: type: string - name: X-ECOMP-RequestID in: header description: X-ECOMP-RequestID header style: simple schema: type: string - name: X-ECOMP-InstanceID in: header description: X-ECOMP-InstanceID header required: true style: simple schema: type: string - name: Accept in: header description: Determines the format of the body of the response style: simple schema: type: string - name: Authorization in: header description: The username and password required: true style: simple schema: type: string - name: assetType in: path description: The requested asset type required: true style: simple schema: allOf: - $ref: '#/components/schemas/assetType' - description: The requested asset type - name: uuid in: path description: The uuid of the asset as published in the metadata required: true style: simple schema: type: string - name: artifactUUID in: path description: The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation required: true style: simple schema: type: string requestBody: description: json describe the artifact content: application/json: schema: allOf: - $ref: '#/components/schemas/ArtifactDefinition' - description: json describe the artifact required: true responses: '200': description: Artifact updated headers: {} content: application/json: schema: $ref: '#/components/schemas/ArtifactDefinition' '400': description: Artifact name is missing in input - SVC4128 headers: {} content: {} '401': description: ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002 headers: {} content: {} '403': description: Asset is being edited by different user. Only one user can checkout and edit an asset on given time. The asset will be available for checkout after the other user will checkin the asset - SVC4086 headers: {} content: {} '404': description: Specified resource is not found - SVC4063 headers: {} content: {} '405': description: 'Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050' headers: {} content: {} '409': description: Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301 headers: {} content: {} '500': description: The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000 headers: {} content: {} deprecated: false delete: tags: - Artifact External Servlet summary: deleteArtifact description: deletes an artifact of a resource or service operationId: deleteArtifact parameters: - name: USER_ID in: header description: The user ID of the DCAE Designer. This user must also have Designer role in SDC required: true style: simple schema: type: string - name: X-ECOMP-RequestID in: header description: X-ECOMP-RequestID header style: simple schema: type: string - name: X-ECOMP-InstanceID in: header description: X-ECOMP-InstanceID header required: true style: simple schema: type: string - name: Accept in: header description: Determines the format of the body of the response style: simple schema: type: string - name: Authorization in: header description: The username and password required: true style: simple schema: type: string - name: assetType in: path description: The requested asset type required: true style: simple schema: allOf: - $ref: '#/components/schemas/assetType' - description: The requested asset type - name: uuid in: path description: The uuid of the asset as published in the metadata required: true style: simple schema: type: string - name: artifactUUID in: path description: The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation required: true style: simple schema: type: string responses: '200': description: Artifact deleted headers: {} content: application/json: schema: $ref: '#/components/schemas/ArtifactDefinition' '400': description: Artifact name is missing in input - SVC4128 headers: {} content: {} '401': description: ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002 headers: {} content: {} '403': description: Asset is being edited by different user. Only one user can checkout and edit an asset on given time. The asset will be available for checkout after the other user will checkin the asset - SVC4086 headers: {} content: {} '404': description: Specified resource is not found - SVC4063 headers: {} content: {} '405': description: 'Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050' headers: {} content: {} '409': description: Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301 headers: {} content: {} '500': description: The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000 headers: {} content: {} deprecated: false /v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceName}/artifacts: post: tags: - Artifact External Servlet summary: uploadArtifactToInstance description: uploads an artifact to a resource instance operationId: uploadArtifactToInstance parameters: - name: Content-MD5 in: header description: The value for this header must be the MD5 checksum over the whole json body required: true style: simple schema: type: string - name: USER_ID in: header description: The user ID of the DCAE Designer. This user must also have Designer role in SDC required: true style: simple schema: type: string - name: X-ECOMP-RequestID in: header description: X-ECOMP-RequestID header style: simple schema: type: string - name: X-ECOMP-InstanceID in: header description: X-ECOMP-InstanceID header required: true style: simple schema: type: string - name: Accept in: header description: Determines the format of the body of the response style: simple schema: type: string - name: Authorization in: header description: The username and password required: true style: simple schema: type: string - name: assetType in: path description: The requested asset type required: true style: simple schema: allOf: - $ref: '#/components/schemas/assetType' - description: The requested asset type - name: uuid in: path description: The uuid of the asset as published in the metadata required: true style: simple schema: type: string - name: resourceInstanceName in: path description: The component instance name (as publishedin the response of the detailed query) required: true style: simple schema: type: string requestBody: description: json describe the artifact content: application/json: schema: allOf: - $ref: '#/components/schemas/ArtifactDefinition' - description: json describe the artifact required: true responses: '200': description: Artifact uploaded headers: {} content: application/json: schema: $ref: '#/components/schemas/ArtifactDefinition' '400': description: Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301 headers: {} content: {} '401': description: ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002 headers: {} content: {} '403': description: ECOMP component is not authorized - POL5003 headers: {} content: {} '404': description: Specified resource is not found - SVC4063 headers: {} content: {} '405': description: 'Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050' headers: {} content: {} '500': description: The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000 headers: {} content: {} deprecated: false /v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceName}/artifacts/{artifactUUID}: get: tags: - Artifact External Servlet summary: downloadResourceInstanceArtifact description: Returns downloaded artifact operationId: downloadResourceInstanceArtifact parameters: - name: USER_ID in: header description: The user ID of the DCAE Designer. This user must also have Designer role in SDC required: true style: simple schema: type: string - name: X-ECOMP-RequestID in: header description: X-ECOMP-RequestID header style: simple schema: type: string - name: X-ECOMP-InstanceID in: header description: X-ECOMP-InstanceID header required: true style: simple schema: type: string - name: Accept in: header description: Determines the format of the body of the response style: simple schema: type: string - name: Authorization in: header description: The username and password required: true style: simple schema: type: string - name: assetType in: path description: The requested asset type required: true style: simple schema: allOf: - $ref: '#/components/schemas/assetType' - description: The requested asset type - name: uuid in: path description: The uuid of the asset as published in the metadata required: true style: simple schema: type: string - name: artifactUUID in: path description: The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation required: true style: simple schema: type: string - name: resourceInstanceName in: path description: The component instance name (as publishedin the response of the detailed query) required: true style: simple schema: type: string responses: '200': description: Artifact downloaded headers: {} content: application/octet-stream: schema: type: string description: Artifact downloaded format: binary '400': description: Missing 'X-ECOMP-InstanceID' HTTP header - POL5001 headers: {} content: {} '401': description: ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002 headers: {} content: {} '403': description: ECOMP component is not authorized - POL5003 headers: {} content: {} '404': description: Artifact was not found - SVC4505 headers: {} content: {} '405': description: 'Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050' headers: {} content: {} '500': description: The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000 headers: {} content: {} deprecated: false post: tags: - Artifact External Servlet summary: updateArtifactOnResourceInstance description: uploads of artifact to a resource or service operationId: updateArtifactOnResourceInstance parameters: - name: Content-MD5 in: header description: The value for this header must be the MD5 checksum over the whole json body required: true style: simple schema: type: string - name: USER_ID in: header description: The user ID of the DCAE Designer. This user must also have Designer role in SDC required: true style: simple schema: type: string - name: X-ECOMP-RequestID in: header description: X-ECOMP-RequestID header style: simple schema: type: string - name: X-ECOMP-InstanceID in: header description: X-ECOMP-InstanceID header required: true style: simple schema: type: string - name: Accept in: header description: Determines the format of the body of the response style: simple schema: type: string - name: Authorization in: header description: The username and password required: true style: simple schema: type: string - name: assetType in: path description: The requested asset type required: true style: simple schema: allOf: - $ref: '#/components/schemas/assetType' - description: The requested asset type - name: uuid in: path description: The uuid of the asset as published in the metadata required: true style: simple schema: type: string - name: artifactUUID in: path description: The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation required: true style: simple schema: type: string - name: resourceInstanceName in: path description: The component instance name (as publishedin the response of the detailed query) required: true style: simple schema: type: string requestBody: description: json describe the artifact content: application/json: schema: allOf: - $ref: '#/components/schemas/ArtifactDefinition' - description: json describe the artifact required: true responses: '200': description: Artifact updated headers: {} content: application/json: schema: $ref: '#/components/schemas/ArtifactDefinition' '400': description: Artifact name is missing in input - SVC4128 headers: {} content: {} '401': description: ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002 headers: {} content: {} '403': description: Asset is being edited by different user. Only one user can checkout and edit an asset on given time. The asset will be available for checkout after the other user will checkin the asset - SVC4086 headers: {} content: {} '404': description: Specified resource is not found - SVC4063 headers: {} content: {} '405': description: 'Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050' headers: {} content: {} '409': description: Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301 headers: {} content: {} '500': description: The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000 headers: {} content: {} deprecated: false delete: tags: - Artifact External Servlet summary: deleteArtifactOnResourceInstance description: deletes an artifact of a resource insatnce operationId: deleteArtifactOnResourceInstance parameters: - name: USER_ID in: header description: The user ID of the DCAE Designer. This user must also have Designer role in SDC required: true style: simple schema: type: string - name: X-ECOMP-RequestID in: header description: X-ECOMP-RequestID header style: simple schema: type: string - name: X-ECOMP-InstanceID in: header description: X-ECOMP-InstanceID header required: true style: simple schema: type: string - name: Accept in: header description: Determines the format of the body of the response style: simple schema: type: string - name: Authorization in: header description: The username and password required: true style: simple schema: type: string - name: assetType in: path description: The requested asset type required: true style: simple schema: allOf: - $ref: '#/components/schemas/assetType' - description: The requested asset type - name: uuid in: path description: The uuid of the asset as published in the metadata required: true style: simple schema: type: string - name: artifactUUID in: path description: The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation required: true style: simple schema: type: string - name: resourceInstanceName in: path description: The component instance name (as publishedin the response of the detailed query) required: true style: simple schema: type: string responses: '200': description: Artifact deleted headers: {} content: application/json: schema: $ref: '#/components/schemas/ArtifactDefinition' '400': description: Artifact name is missing in input - SVC4128 headers: {} content: {} '401': description: ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002 headers: {} content: {} '403': description: Asset is being edited by different user. Only one user can checkout and edit an asset on given time. The asset will be available for checkout after the other user will checkin the asset - SVC4086 headers: {} content: {} '404': description: Specified resource is not found - SVC4063 headers: {} content: {} '405': description: 'Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050' headers: {} content: {} '409': description: Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301 headers: {} content: {} '500': description: The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000 headers: {} content: {} deprecated: false /v1/catalog/resources/{uuid}/interfaces/{operationUUID}/artifacts/{artifactUUID}: post: tags: - Artifact External Servlet summary: uploadInterfaceOperationArtifact description: uploads of artifact to VF operation workflow operationId: uploadInterfaceOperationArtifact parameters: - name: Content-MD5 in: header description: The value for this header must be the MD5 checksum over the whole json body required: true style: simple schema: type: string - name: USER_ID in: header description: The user ID of the DCAE Designer. This user must also have Designer role in SDC required: true style: simple schema: type: string - name: X-ECOMP-RequestID in: header description: X-ECOMP-RequestID header style: simple schema: type: string - name: X-ECOMP-InstanceID in: header description: X-ECOMP-InstanceID header required: true style: simple schema: type: string - name: Accept in: header description: Determines the format of the body of the response style: simple schema: type: string - name: Authorization in: header description: The username and password required: true style: simple schema: type: string - name: uuid in: path description: The uuid of the asset as published in the metadata required: true style: simple schema: type: string - name: operationUUID in: path description: The uuid of the operation required: true style: simple schema: type: string - name: artifactUUID in: path description: The uuid of the artifact required: true style: simple schema: type: string requestBody: description: json describe the artifact content: application/json: schema: allOf: - $ref: '#/components/schemas/ArtifactDefinition' - description: json describe the artifact required: true responses: '200': description: Artifact uploaded headers: {} content: application/json: schema: $ref: '#/components/schemas/ArtifactDefinition' '400': description: Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301 headers: {} content: {} '401': description: ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002 headers: {} content: {} '403': description: ECOMP component is not authorized - POL5003 headers: {} content: {} '404': description: Specified resource is not found - SVC4063 headers: {} content: {} '405': description: 'Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050' headers: {} content: {} '500': description: The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000 headers: {} content: {} deprecated: false /v1/catalog/{assetType}: get: tags: - Asset Metadata External Servlet summary: getAssetListExternal description: Returns list of assets operationId: getAssetListExternal parameters: - name: X-ECOMP-RequestID in: header description: X-ECOMP-RequestID header style: simple schema: type: string - name: X-ECOMP-InstanceID in: header description: X-ECOMP-InstanceID header required: true style: simple schema: type: string - name: Accept in: header description: Determines the format of the body of the response style: simple schema: type: string - name: Authorization in: header description: The username and password required: true style: simple schema: type: string - name: assetType in: path description: The requested asset type required: true style: simple schema: allOf: - $ref: '#/components/schemas/assetType' - description: The requested asset type - name: category in: query description: The filter key (resourceType only for resources) style: form explode: true schema: type: string - name: subCategory in: query description: The filter key (resourceType only for resources) style: form explode: true schema: type: string - name: distributionStatus in: query description: The filter key (resourceType only for resources) style: form explode: true schema: type: string - name: resourceType in: query description: The filter key (resourceType only for resources) style: form explode: true schema: type: string responses: '200': description: ECOMP component is authenticated and list of Catalog Assets Metadata is returned headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/AssetMetadata' description: ECOMP component is authenticated and list of Catalog Assets Metadata is returned '400': description: Missing 'X-ECOMP-InstanceID' HTTP header - POL5001 headers: {} content: {} '401': description: ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002 headers: {} content: {} '403': description: ECOMP component is not authorized - POL5003 headers: {} content: {} '405': description: 'Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050' headers: {} content: {} '500': description: The GET request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000 headers: {} content: {} deprecated: false post: tags: - CRUD External Servlet summary: createResourceExternal description: Creates a resource operationId: createResourceExternal parameters: - name: USER_ID in: header description: The user id required: true style: simple schema: type: string - name: X-ECOMP-RequestID in: header description: X-ECOMP-RequestID header style: simple schema: type: string - name: X-ECOMP-InstanceID in: header description: X-ECOMP-InstanceID header required: true style: simple schema: type: string - name: Accept in: header description: Determines the format of the body of the response style: simple schema: type: string - name: Authorization in: header description: The username and password required: true style: simple schema: type: string - name: assetType in: path description: The requested asset type required: true style: simple schema: allOf: - $ref: '#/components/schemas/assetType' - description: The requested asset type requestBody: description: json describe the created resource content: application/json: schema: allOf: - $ref: '#/components/schemas/Resource' - description: json describe the created resource required: true responses: '200': description: ECOMP component is authenticated and Asset created headers: {} content: application/json: schema: $ref: '#/components/schemas/Resource' '400': description: 'Create VFCMT request: VFCMT name exceeds character limit - SVC4073' headers: {} content: {} '401': description: ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002 headers: {} content: {} '403': description: ECOMP component is not authorized - POL5003 headers: {} content: {} '404': description: "Error: Requested '%1' (uuid) resource was not found - SVC4063" headers: {} content: {} '405': description: 'Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050' headers: {} content: {} '500': description: The GET request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000 headers: {} content: {} deprecated: false /v1/catalog/{assetType}/{uuid}/metadata: get: tags: - Asset Metadata External Servlet summary: getAssetSpecificMetadataByUuidExternal description: Returns detailed metadata of an asset by uuid operationId: getAssetSpecificMetadataByUuidExternal parameters: - name: X-ECOMP-RequestID in: header description: X-ECOMP-RequestID header style: simple schema: type: string - name: X-ECOMP-InstanceID in: header description: X-ECOMP-InstanceID header required: true style: simple schema: type: string - name: Accept in: header description: Determines the format of the body of the response style: simple schema: type: string - name: Authorization in: header description: The username and password required: true style: simple schema: type: string - name: assetType in: path description: The requested asset type required: true style: simple schema: allOf: - $ref: '#/components/schemas/assetType' - description: The requested asset type - name: uuid in: path description: The requested asset uuid required: true style: simple schema: type: string responses: '200': description: ECOMP component is authenticated and list of Catalog Assets Metadata is returned headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/AssetMetadata' description: ECOMP component is authenticated and list of Catalog Assets Metadata is returned '400': description: Missing 'X-ECOMP-InstanceID' HTTP header - POL5001 headers: {} content: {} '401': description: ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002 headers: {} content: {} '403': description: ECOMP component is not authorized - POL5003 headers: {} content: {} '404': description: "Error: Requested '%1' (uuid) resource was not found - SVC4063" headers: {} content: {} '405': description: 'Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050' headers: {} content: {} '500': description: The GET request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000 headers: {} content: {} deprecated: false /v1/catalog/{assetType}/{uuid}/toscaModel: get: tags: - Asset Metadata External Servlet summary: getToscaModelExternal description: Returns asset csar operationId: getToscaModelExternal parameters: - name: X-ECOMP-RequestID in: header description: X-ECOMP-RequestID header style: simple schema: type: string - name: X-ECOMP-InstanceID in: header description: X-ECOMP-InstanceID header required: true style: simple schema: type: string - name: Accept in: header description: Determines the format of the body of the response style: simple schema: type: string - name: Authorization in: header description: The username and password required: true style: simple schema: type: string - name: assetType in: path description: The requested asset type required: true style: simple schema: allOf: - $ref: '#/components/schemas/assetType' - description: The requested asset type - name: uuid in: path description: The requested asset uuid required: true style: simple schema: type: string responses: '200': description: ECOMP component is authenticated and list of Catalog Assets Metadata is returned headers: {} content: application/octet-stream: schema: type: string description: ECOMP component is authenticated and list of Catalog Assets Metadata is returned format: binary '400': description: Missing 'X-ECOMP-InstanceID' HTTP header - POL5001 headers: {} content: {} '401': description: ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002 headers: {} content: {} '403': description: ECOMP component is not authorized - POL5003 headers: {} content: {} '404': description: "Error: Requested '%1' (uuid) resource was not found - SVC4063" headers: {} content: {} '405': description: 'Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050' headers: {} content: {} '500': description: The GET request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000 headers: {} content: {} deprecated: false /v1/catalog/{assetType}/{uuid}/lifecycleState/{lifecycleOperation}: post: tags: - CRUD External Servlet summary: changeResourceStateExternal description: Change Resource lifecycle State operationId: changeResourceStateExternal parameters: - name: USER_ID in: header description: The user id required: true style: simple schema: type: string - name: X-ECOMP-RequestID in: header description: X-ECOMP-RequestID header style: simple schema: type: string - name: X-ECOMP-InstanceID in: header description: X-ECOMP-InstanceID header required: true style: simple schema: type: string - name: Accept in: header description: Determines the format of the body of the response style: simple schema: type: string - name: Authorization in: header description: The username and password required: true style: simple schema: type: string - name: lifecycleOperation in: path description: '' required: true style: simple schema: $ref: '#/components/schemas/lifecycleOperation' - name: uuid in: path description: id of component to be changed required: true style: simple schema: type: string - name: assetType in: path description: 'validValues: resources / services' required: true style: simple schema: allOf: - $ref: '#/components/schemas/assetType' - description: 'validValues: resources / services' requestBody: description: userRemarks - Short description (free text) about the asset version being changed content: application/json: schema: allOf: - $ref: '#/components/schemas/LifecycleChangeInfoWithAction' - description: userRemarks - Short description (free text) about the asset version being changed required: true responses: '200': description: Resource state changed headers: {} content: application/json: schema: $ref: '#/components/schemas/AssetMetadata' '400': description: Missing X-ECOMP-InstanceID HTTP header - POL5001 headers: {} content: {} '401': description: ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002 headers: {} content: {} '403': description: Asset is being edited by different user. Only one user can checkout and edit an asset on given time. The asset will be available for checkout after the other user will checkin the asset - SVC4080 headers: {} content: {} '404': description: "Error: Requested '%1' (uuid) resource was not found - SVC4063" headers: {} content: {} '405': description: 'Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050' headers: {} content: {} '500': description: The GET request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000 headers: {} content: {} deprecated: false /v1/catalog/services/{serviceUUID}/distribution/{opEnvId}/activate: post: tags: - Service Activation External Servlet summary: activateServiceExternal description: Activates a service operationId: activateServiceExternal parameters: - name: USER_ID in: header description: The user id required: true style: simple schema: type: string - name: X-ECOMP-RequestID in: header description: X-ECOMP-RequestID header style: simple schema: type: string - name: X-ECOMP-InstanceID in: header description: X-ECOMP-InstanceID header required: true style: simple schema: type: string - name: Accept in: header description: Determines the format of the body of the response style: simple schema: type: string - name: Authorization in: header description: The username and password required: true style: simple schema: type: string - name: serviceUUID in: path description: The serviceUUid to activate required: true style: simple schema: type: string - name: opEnvId in: path description: The operational environment on which to activate the service on required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: string required: false responses: '202': description: ECOMP component is authenticated and required service may be distributed headers: {} content: {} '400': description: The resource name is missing in the request body - SVC4062 headers: {} content: {} '401': description: ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002 headers: {} content: {} '403': description: ECOMP component is not authorized - POL5003 headers: {} content: {} '404': description: "Error: Requested '%1' (uuid) resource was not found - SVC4063" headers: {} content: {} '405': description: 'Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050' headers: {} content: {} '409': description: Service state is invalid for this action headers: {} content: {} '500': description: The request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000 headers: {} content: {} '502': description: The server was acting as a gateway or proxy and received an invalid response from the upstream server headers: {} content: {} deprecated: false components: schemas: TopicRegistrationResponse: title: TopicRegistrationResponse type: object properties: distrNotificationTopicName: type: string distrStatusTopicName: type: string RegistrationRequest: title: RegistrationRequest type: object properties: apiPublicKey: type: string distrEnvName: type: string isConsumerToSdcDistrStatusTopic: type: boolean distEnvEndPoints: type: array items: type: string description: '' TopicUnregistrationResponse: title: TopicUnregistrationResponse type: object properties: distrNotificationTopicName: type: string distrStatusTopicName: type: string notificationUnregisterResult: $ref: '#/components/schemas/NotificationUnregisterResult' statusUnregisterResult: $ref: '#/components/schemas/StatusUnregisterResult' ServerListResponse: title: ServerListResponse type: object properties: uebServerList: type: array items: type: string description: '' ArtifactDefinition: title: ArtifactDefinition type: object properties: payloadData: type: array items: type: string description: '' listHeatParameters: type: array items: $ref: '#/components/schemas/HeatParameterDefinition' description: '' creationDate: type: integer format: int64 timeout: type: integer format: int32 esId: type: string description: type: string artifactLabel: type: string artifactUUID: type: string artifactVersion: type: string heatParameters: type: array items: $ref: '#/components/schemas/HeatParameterDataDefinition' description: '' artifactGroupType: $ref: '#/components/schemas/ArtifactGroupType' heatParamsUpdateDate: type: integer format: int64 artifactChecksum: type: string generatedFromId: type: string mandatory: type: boolean serviceApi: type: boolean payloadUpdateDate: type: integer format: int64 artifactName: type: string artifactType: type: string artifactRef: type: string apiUrl: type: string artifactRepository: type: string userIdCreator: type: string artifactCreator: type: string userIdLastUpdater: type: string updaterFullName: type: string isFromCsar: type: boolean requiredArtifacts: type: array items: type: string description: '' creatorFullName: type: string artifactDisplayName: type: string uniqueId: type: string generated: type: boolean duplicated: type: boolean lastUpdateDate: type: integer format: int64 empty: type: boolean ownerId: type: string HeatParameterDataDefinition: title: HeatParameterDataDefinition type: object properties: uniqueId: type: string name: type: string type: type: string description: type: string currentValue: type: string defaultValue: type: string empty: type: boolean ownerId: type: string HeatParameterDefinition: title: HeatParameterDefinition type: object properties: uniqueId: type: string name: type: string type: type: string description: type: string currentValue: type: string defaultValue: type: string empty: type: boolean ownerId: type: string AssetMetadata: title: AssetMetadata type: object properties: uuid: type: string invariantUUID: type: string name: type: string version: type: string toscaModelURL: type: string LifecycleChangeInfoWithAction: title: LifecycleChangeInfoWithAction type: object properties: userRemarks: type: string action: $ref: '#/components/schemas/Action' AdditionalInfoParameterInfo: title: AdditionalInfoParameterInfo type: object properties: uniqueId: type: string key: type: string value: type: string empty: type: boolean ownerId: type: string AdditionalInformationDefinition: title: AdditionalInformationDefinition type: object properties: uniqueId: type: string creationTime: type: integer format: int64 modificationTime: type: integer format: int64 lastCreatedCounter: type: integer format: int32 parameters: type: array items: $ref: '#/components/schemas/AdditionalInfoParameterInfo' description: '' parentUniqueId: type: string empty: type: boolean ownerId: type: string ArtifactDataDefinition: title: ArtifactDataDefinition type: object properties: creationDate: type: integer format: int64 timeout: type: integer format: int32 esId: type: string description: type: string artifactLabel: type: string artifactUUID: type: string artifactVersion: type: string heatParameters: type: array items: $ref: '#/components/schemas/HeatParameterDataDefinition' description: '' artifactGroupType: $ref: '#/components/schemas/ArtifactGroupType' heatParamsUpdateDate: type: integer format: int64 artifactChecksum: type: string generatedFromId: type: string mandatory: type: boolean serviceApi: type: boolean payloadUpdateDate: type: integer format: int64 artifactName: type: string artifactType: type: string artifactRef: type: string apiUrl: type: string artifactRepository: type: string userIdCreator: type: string artifactCreator: type: string userIdLastUpdater: type: string updaterFullName: type: string isFromCsar: type: boolean requiredArtifacts: type: array items: type: string description: '' creatorFullName: type: string artifactDisplayName: type: string uniqueId: type: string generated: type: boolean duplicated: type: boolean lastUpdateDate: type: integer format: int64 empty: type: boolean ownerId: type: string CapabilityDataDefinition: title: CapabilityDataDefinition type: object properties: name: type: string type: type: string path: type: array items: type: string description: '' parentName: type: string source: type: string description: type: string capabilitySources: type: array items: type: string description: '' minOccurrences: type: string maxOccurrences: type: string validSourceTypes: type: array items: type: string description: '' leftOccurrences: type: string ownerName: type: string ownerId: type: string uniqueId: type: string empty: type: boolean CapabilityDefinition: title: CapabilityDefinition type: object properties: properties: type: array items: $ref: '#/components/schemas/ComponentInstanceProperty' description: '' name: type: string type: type: string path: type: array items: type: string description: '' parentName: type: string source: type: string description: type: string capabilitySources: type: array items: type: string description: '' minOccurrences: type: string maxOccurrences: type: string validSourceTypes: type: array items: type: string description: '' leftOccurrences: type: string ownerName: type: string ownerId: type: string uniqueId: type: string empty: type: boolean CapabilityRequirementRelationship: title: CapabilityRequirementRelationship type: object properties: relation: $ref: '#/components/schemas/RelationshipInfo' capability: $ref: '#/components/schemas/CapabilityDataDefinition' requirement: $ref: '#/components/schemas/RequirementDataDefinition' CategoryDefinition: title: CategoryDefinition type: object properties: name: type: string normalizedName: type: string uniqueId: type: string icons: type: array items: type: string description: '' subcategories: type: array items: $ref: '#/components/schemas/SubCategoryDefinition' description: '' empty: type: boolean ownerId: type: string ComponentInstance: title: ComponentInstance type: object properties: capabilities: type: object additionalProperties: type: object requirements: type: object additionalProperties: type: object deploymentArtifacts: type: object additionalProperties: $ref: '#/components/schemas/ArtifactDefinition' artifacts: type: object additionalProperties: $ref: '#/components/schemas/ArtifactDefinition' groupInstances: type: array items: $ref: '#/components/schemas/GroupInstance' description: '' actualComponentUid: type: string name: type: string uniqueId: type: string normalizedName: type: string creationTime: type: integer format: int64 sourceModelInvariant: type: string sourceModelUuid: type: string sourceModelName: type: string sourceModelUid: type: string invariantName: type: string posX: type: string posY: type: string originType: $ref: '#/components/schemas/OriginType' description: type: string propertyValueCounter: type: integer format: int32 customizationUUID: type: string modificationTime: type: integer format: int64 componentUid: type: string componentVersion: type: string componentName: type: string toscaComponentName: type: string isProxy: type: boolean icon: type: string attributeValueCounter: type: integer format: int32 inputValueCounter: type: integer format: int32 empty: type: boolean ownerId: type: string ComponentInstanceInput: title: ComponentInstanceInput type: object properties: uniqueId: type: string type: type: string required: type: boolean definition: type: boolean defaultValue: type: string description: type: string schema: $ref: '#/components/schemas/SchemaDefinition' password: type: boolean name: type: string value: type: string label: type: string hidden: type: boolean immutable: type: boolean inputPath: type: string status: type: string inputId: type: string instanceUniqueId: type: string propertyId: type: string parentUniqueId: type: string getInputValues: type: array items: $ref: '#/components/schemas/GetInputValueDataDefinition' description: '' constraints: type: array items: type: object description: '' inputs: type: array items: $ref: '#/components/schemas/ComponentInstanceInput' description: '' properties: type: array items: $ref: '#/components/schemas/ComponentInstanceProperty' description: '' valueUniqueUid: type: string path: type: array items: type: string description: '' rules: type: array items: $ref: '#/components/schemas/PropertyRule' description: '' componentInstanceName: type: string componentInstanceId: type: string schemaType: type: string getInputProperty: type: boolean empty: type: boolean ownerId: type: string ComponentInstanceProperty: title: ComponentInstanceProperty type: object properties: uniqueId: type: string type: type: string required: type: boolean definition: type: boolean defaultValue: type: string description: type: string schema: $ref: '#/components/schemas/SchemaDefinition' password: type: boolean name: type: string value: type: string label: type: string hidden: type: boolean immutable: type: boolean inputPath: type: string status: type: string inputId: type: string instanceUniqueId: type: string propertyId: type: string parentUniqueId: type: string getInputValues: type: array items: $ref: '#/components/schemas/GetInputValueDataDefinition' description: '' constraints: type: array items: type: object description: '' valueUniqueUid: type: string path: type: array items: type: string description: '' rules: type: array items: $ref: '#/components/schemas/PropertyRule' description: '' componentInstanceName: type: string componentInstanceId: type: string schemaType: type: string getInputProperty: type: boolean empty: type: boolean ownerId: type: string GetInputValueDataDefinition: title: GetInputValueDataDefinition type: object properties: propName: type: string inputName: type: string inputId: type: string indexValue: type: integer format: int32 getInputIndex: $ref: '#/components/schemas/GetInputValueDataDefinition' list: type: boolean empty: type: boolean ownerId: type: string GroupDefinition: title: GroupDefinition type: object properties: typeUid: type: string propertyValueCounter: type: integer format: int32 name: type: string properties: type: array items: $ref: '#/components/schemas/PropertyDataDefinition' description: '' type: type: string members: type: object additionalProperties: type: string version: type: string artifacts: type: array items: type: string description: '' invariantUUID: type: string artifactsUuid: type: array items: type: string description: '' groupUUID: type: string description: type: string uniqueId: type: string empty: type: boolean ownerId: type: string GroupInstance: title: GroupInstance type: object properties: name: type: string properties: type: array items: $ref: '#/components/schemas/PropertyDataDefinition' description: '' type: type: string creationTime: type: integer format: int64 version: type: string groupName: type: string posX: type: string posY: type: string artifacts: type: array items: type: string description: '' groupUid: type: string groupInstanceArtifacts: type: array items: type: string description: '' groupInstanceArtifactsUuid: type: array items: type: string description: '' invariantUUID: type: string artifactsUuid: type: array items: type: string description: '' groupUUID: type: string description: type: string propertyValueCounter: type: integer format: int32 customizationUUID: type: string modificationTime: type: integer format: int64 normalizedName: type: string uniqueId: type: string empty: type: boolean ownerId: type: string GroupingDefinition: title: GroupingDefinition type: object properties: name: type: string normalizedName: type: string uniqueId: type: string empty: type: boolean ownerId: type: string InputDefinition: title: InputDefinition type: object properties: uniqueId: type: string type: type: string required: type: boolean definition: type: boolean defaultValue: type: string description: type: string schema: $ref: '#/components/schemas/SchemaDefinition' password: type: boolean name: type: string value: type: string label: type: string hidden: type: boolean immutable: type: boolean inputPath: type: string status: type: string inputId: type: string instanceUniqueId: type: string propertyId: type: string parentUniqueId: type: string getInputValues: type: array items: $ref: '#/components/schemas/GetInputValueDataDefinition' description: '' constraints: type: array items: type: object description: '' inputs: type: array items: $ref: '#/components/schemas/ComponentInstanceInput' description: '' properties: type: array items: $ref: '#/components/schemas/ComponentInstanceProperty' description: '' schemaType: type: string getInputProperty: type: boolean empty: type: boolean ownerId: type: string InterfaceDefinition: title: InterfaceDefinition type: object properties: definition: type: boolean type: type: string creationDate: type: integer format: int64 description: type: string uniqueId: type: string operations: type: object additionalProperties: $ref: '#/components/schemas/OperationDataDefinition' toscaResourceName: type: string lastUpdateDate: type: integer format: int64 empty: type: boolean ownerId: type: string InterfaceOperationDataDefinition: title: InterfaceOperationDataDefinition type: object properties: description: type: string artifactUUID: type: string inputParams: $ref: '#/components/schemas/ListDataDefinitionInterfaceOperationParamDataDefinition' uniqueId: type: string toscaResourceName: type: string outputParams: $ref: '#/components/schemas/ListDataDefinitionInterfaceOperationParamDataDefinition' operationType: type: string empty: type: boolean ownerId: type: string InterfaceOperationParamDataDefinition: title: InterfaceOperationParamDataDefinition type: object properties: paramName: type: string paramId: type: string empty: type: boolean ownerId: type: string ListDataDefinition: title: ListDataDefinition type: object properties: listToscaDataDefinition: type: array items: $ref: '#/components/schemas/ToscaDataDefinition' description: '' empty: type: boolean ownerId: type: string ListDataDefinitionInterfaceOperationParamDataDefinition: title: ListDataDefinitionInterfaceOperationParamDataDefinition type: object properties: listToscaDataDefinition: type: array items: $ref: '#/components/schemas/InterfaceOperationParamDataDefinition' description: '' empty: type: boolean ownerId: type: string ListDataDefinitionOperationInputDefinition: title: ListDataDefinitionOperationInputDefinition type: object properties: listToscaDataDefinition: type: array items: $ref: '#/components/schemas/OperationInputDefinition' description: '' empty: type: boolean ownerId: type: string OperationDataDefinition: title: OperationDataDefinition type: object properties: name: type: string creationDate: type: integer format: int64 description: type: string inputs: $ref: '#/components/schemas/ListDataDefinitionOperationInputDefinition' uniqueId: type: string lastUpdateDate: type: integer format: int64 implementation: $ref: '#/components/schemas/ArtifactDataDefinition' empty: type: boolean ownerId: type: string OperationInputDefinition: title: OperationInputDefinition type: object properties: uniqueId: type: string type: type: string required: type: boolean definition: type: boolean defaultValue: type: string description: type: string schema: $ref: '#/components/schemas/SchemaDefinition' password: type: boolean name: type: string value: type: string label: type: string hidden: type: boolean immutable: type: boolean inputPath: type: string status: type: string inputId: type: string instanceUniqueId: type: string propertyId: type: string parentUniqueId: type: string getInputValues: type: array items: $ref: '#/components/schemas/GetInputValueDataDefinition' description: '' schemaType: type: string getInputProperty: type: boolean empty: type: boolean ownerId: type: string PolicyDefinition: title: PolicyDefinition type: object properties: normalizedName: type: string name: type: string uniqueId: type: string properties: type: array items: $ref: '#/components/schemas/PropertyDataDefinition' description: '' version: type: string invariantName: type: string invariantUUID: type: string description: type: string derivedFrom: type: string targets: type: object additionalProperties: type: object isFromCsar: type: boolean policyTypeName: type: string policyTypeUid: type: string policyUUID: type: string componentName: type: string empty: type: boolean ownerId: type: string PropertyDataDefinition: title: PropertyDataDefinition type: object properties: uniqueId: type: string type: type: string required: type: boolean definition: type: boolean defaultValue: type: string description: type: string schema: $ref: '#/components/schemas/SchemaDefinition' password: type: boolean name: type: string value: type: string label: type: string hidden: type: boolean immutable: type: boolean inputPath: type: string status: type: string inputId: type: string instanceUniqueId: type: string propertyId: type: string parentUniqueId: type: string getInputValues: type: array items: $ref: '#/components/schemas/GetInputValueDataDefinition' description: '' schemaType: type: string getInputProperty: type: boolean empty: type: boolean ownerId: type: string PropertyDefinition: title: PropertyDefinition type: object properties: uniqueId: type: string type: type: string required: type: boolean definition: type: boolean defaultValue: type: string description: type: string schema: $ref: '#/components/schemas/SchemaDefinition' password: type: boolean name: type: string value: type: string label: type: string hidden: type: boolean immutable: type: boolean inputPath: type: string status: type: string inputId: type: string instanceUniqueId: type: string propertyId: type: string parentUniqueId: type: string getInputValues: type: array items: $ref: '#/components/schemas/GetInputValueDataDefinition' description: '' constraints: type: array items: type: object description: '' schemaType: type: string getInputProperty: type: boolean empty: type: boolean ownerId: type: string PropertyRule: title: PropertyRule type: object properties: rule: type: array items: type: string description: '' value: type: string empty: type: boolean ownerId: type: string RelationshipImpl: title: RelationshipImpl type: object properties: type: type: string RelationshipInfo: title: RelationshipInfo type: object properties: requirement: type: string capabilityOwnerId: type: string requirementOwnerId: type: string id: type: string relationship: $ref: '#/components/schemas/RelationshipImpl' capability: type: string capabilityUid: type: string requirementUid: type: string RequirementCapabilityRelDef: title: RequirementCapabilityRelDef type: object properties: uid: type: string toNode: type: string relationships: type: array items: $ref: '#/components/schemas/CapabilityRequirementRelationship' description: '' fromNode: type: string RequirementDataDefinition: title: RequirementDataDefinition type: object properties: name: type: string path: type: array items: type: string description: '' node: type: string parentName: type: string source: type: string minOccurrences: type: string maxOccurrences: type: string capability: type: string leftOccurrences: type: string ownerName: type: string ownerId: type: string relationship: type: string uniqueId: type: string empty: type: boolean RequirementDefinition: title: RequirementDefinition type: object properties: name: type: string path: type: array items: type: string description: '' node: type: string parentName: type: string source: type: string minOccurrences: type: string maxOccurrences: type: string capability: type: string leftOccurrences: type: string ownerName: type: string ownerId: type: string relationship: type: string uniqueId: type: string empty: type: boolean Resource: title: Resource type: object properties: artifacts: type: object additionalProperties: $ref: '#/components/schemas/ArtifactDefinition' deploymentArtifacts: type: object additionalProperties: $ref: '#/components/schemas/ArtifactDefinition' toscaArtifacts: type: object additionalProperties: $ref: '#/components/schemas/ArtifactDefinition' categories: type: array items: $ref: '#/components/schemas/CategoryDefinition' description: '' componentInstances: type: array items: $ref: '#/components/schemas/ComponentInstance' description: '' componentInstancesRelations: type: array items: $ref: '#/components/schemas/RequirementCapabilityRelDef' description: '' componentInstancesInputs: type: object additionalProperties: type: object componentInstancesProperties: type: object additionalProperties: type: object componentInstancesAttributes: type: object additionalProperties: type: object capabilities: type: object additionalProperties: type: object requirements: type: object additionalProperties: type: object inputs: type: array items: $ref: '#/components/schemas/InputDefinition' description: '' groups: type: array items: $ref: '#/components/schemas/GroupDefinition' description: '' policies: type: object additionalProperties: $ref: '#/components/schemas/PolicyDefinition' derivedFromGenericType: type: string derivedFromGenericVersion: type: string toscaType: type: string additionalInformation: type: array items: $ref: '#/components/schemas/AdditionalInformationDefinition' description: '' derivedFrom: type: array items: type: string description: '' derivedList: type: array items: type: string description: '' properties: type: array items: $ref: '#/components/schemas/PropertyDefinition' description: '' attributes: type: array items: $ref: '#/components/schemas/PropertyDefinition' description: '' interfaces: type: object additionalProperties: $ref: '#/components/schemas/InterfaceDefinition' defaultCapabilities: type: array items: type: string description: '' interfaceOperations: type: object additionalProperties: $ref: '#/components/schemas/InterfaceOperationDataDefinition' abstract: type: boolean vendorName: type: string vendorRelease: type: string resourceVendorModelNumber: type: string resourceType: $ref: '#/components/schemas/ResourceType' licenseType: type: string cost: type: string toscaResourceName: type: string componentType: $ref: '#/components/schemas/ComponentType' name: type: string version: type: string creationDate: type: integer format: int64 tags: type: array items: type: string description: '' topologyTemplate: type: boolean invariantUUID: type: string description: type: string isDeleted: type: boolean csarVersion: type: string allVersions: type: object additionalProperties: type: string allArtifacts: type: object additionalProperties: $ref: '#/components/schemas/ArtifactDefinition' csarUUID: type: string importedToscaChecksum: type: string lastUpdaterUserId: type: string lastUpdaterFullName: type: string creatorUserId: type: string highestVersion: type: boolean creatorFullName: type: string normalizedName: type: string contactId: type: string conformanceLevel: type: string projectCode: type: string uniqueId: type: string lifecycleState: $ref: '#/components/schemas/LifecycleState' uuid: type: string systemName: type: string lastUpdateDate: type: integer format: int64 icon: type: string SchemaDefinition: title: SchemaDefinition type: object properties: derivedFrom: type: string constraints: type: array items: type: string description: '' properties: type: object additionalProperties: $ref: '#/components/schemas/PropertyDataDefinition' property: $ref: '#/components/schemas/PropertyDataDefinition' empty: type: boolean ownerId: type: string SubCategoryDefinition: title: SubCategoryDefinition type: object properties: name: type: string normalizedName: type: string uniqueId: type: string icons: type: array items: type: string description: '' groupings: type: array items: $ref: '#/components/schemas/GroupingDefinition' description: '' empty: type: boolean ownerId: type: string ToscaDataDefinition: title: ToscaDataDefinition type: object properties: empty: type: boolean ownerId: type: string Action: title: Action enum: - CREATE_FROM_CSAR - UPDATE_FROM_EXTERNAL_API - UPGRADE_MIGRATION type: string ArtifactGroupType: title: ArtifactGroupType enum: - INFORMATIONAL - DEPLOYMENT - LIFE_CYCLE - SERVICE_API - TOSCA - OTHER type: string assetType: title: assetType enum: - resources - services type: string ComponentType: title: ComponentType enum: - RESOURCE - SERVICE - RESOURCE_INSTANCE - PRODUCT - SERVICE_INSTANCE type: string lifecycleOperation: title: lifecycleOperation enum: - checkout - checkin type: string LifecycleState: title: LifecycleState enum: - READY_FOR_CERTIFICATION - CERTIFICATION_IN_PROGRESS - CERTIFIED - NOT_CERTIFIED_CHECKIN - NOT_CERTIFIED_CHECKOUT type: string NotificationUnregisterResult: title: NotificationUnregisterResult enum: - OK - CONNNECTION_ERROR - NOT_FOUND - TOPIC_ALREADY_EXIST - OBJECT_NOT_FOUND - INTERNAL_SERVER_ERROR - AUTHENTICATION_ERROR - UNKNOWN_HOST_ERROR type: string OriginType: title: OriginType enum: - PRODUCT - SERVICE - VF - VFC - CP - VL - Configuration - VFCMT - CVFC - PNF - CR - ServiceProxy type: string ResourceType: title: ResourceType enum: - VFC - VF - CR - CP - PNF - CVFC - VL - VFCMT - Configuration - ServiceProxy - ABSTRACT type: string StatusUnregisterResult: title: StatusUnregisterResult enum: - OK - CONNNECTION_ERROR - NOT_FOUND - TOPIC_ALREADY_EXIST - OBJECT_NOT_FOUND - INTERNAL_SERVER_ERROR - AUTHENTICATION_ERROR - UNKNOWN_HOST_ERROR type: string tags: - name: Distribution Catalog Servlet - name: Distribution Servlet - name: Artifact External Servlet - name: Asset Metadata External Servlet - name: CRUD External Servlet - name: Service Activation External Servlet