@itentialopensource/adapter-onap_sdc

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: