From db0e898f982954e25c0133cab7a99d9f5e0605ea Mon Sep 17 00:00:00 2001 From: Michael Lando Date: Wed, 6 Jun 2018 11:44:25 +0300 Subject: update documentation update general information update swagger information fix swagger erros Change-Id: I0b8c385deb3204100ebe363177a8e0efd5b147f7 Issue-ID: SDC-1378 Signed-off-by: Michael Lando --- docs/swagger/swagger.html | 12976 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 12976 insertions(+) create mode 100644 docs/swagger/swagger.html (limited to 'docs/swagger/swagger.html') diff --git a/docs/swagger/swagger.html b/docs/swagger/swagger.html new file mode 100644 index 0000000000..cb09cfb40b --- /dev/null +++ b/docs/swagger/swagger.html @@ -0,0 +1,12976 @@ + + + + + + +DistributionAndExternalAPIs + + + + +
+
+

1. Overview

+
+
+

1.1. Version information

+
+

Version : 1.2.0

+
+
+
+

1.2. URI scheme

+
+

BasePath : /sdc

+
+
+
+

1.3. Tags

+
+
    +
  • +

    Artifact External Servlet

    +
    • +
  • +

    Asset Metadata External Servlet

    +
    • +
  • +

    CRUD External Servlet

    +
    • +
  • +

    Distribution Catalog Servlet

    +
    • +
  • +

    Distribution Servlet

    +
    • +
  • +

    Service Activation External Servlet

    +
    • +
+
+
+
+
+
+

2. Paths

+
+
+

2.1. Artifact types list

+
+
+
GET /v1/artifactTypes
+
+
+
+

2.1.1. Description

+
+

Fetches available artifact types list

+
+
+
+

2.1.2. Parameters

+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionSchema
+

Header

+
+

Accept
+required

+
+

The username and password

+
+

string

+
+

Header

+
+

Authorization
+required

+
+

The username and password

+
+

string

+
+

Header

+
+

X-ECOMP-InstanceID
+required

+
+

X-ECOMP-InstanceID header

+
+

string

+
+

Header

+
+

X-ECOMP-RequestID
+optional

+
+

X-ECOMP-RequestID header

+
+

string

+
+ +
+
+

2.1.3. Responses

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema
+

200

+
+

Artifact types list fetched successfully

+
+

string

+
+

400

+
+

Missing X-ECOMP-InstanceID HTTP header - POL5001

+
+

No Content

+
+

401

+
+

ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002

+
+

No Content

+
+

403

+
+

ECOMP component is not authorized - POL5003

+
+

No Content

+
+

405

+
+

Method Not Allowed : Invalid HTTP method type used to register for distribution ( POST,PUT,DELETE will be rejected) - POL4050

+
+

No Content

+
+

500

+
+

The registration failed due to internal SDC problem or Cambria Service failure ECOMP Component should continue the attempts to register for distribution - POL5000

+
+

No Content

+
+ +
+
+

2.1.4. Consumes

+
+
    +
  • +

    application/json

    +
    • +
+
+
+
+

2.1.5. Produces

+
+
    +
  • +

    application/json

    +
    • +
+
+
+
+

2.1.6. Tags

+
+
    +
  • +

    Distribution Servlet

    +
    • +
+
+
+
+
+

2.2. uploads of artifact to VF operation workflow

+
+
+
POST /v1/catalog/resources/{uuid}/interfaces/{operationUUID}/artifacts/{artifactUUID}
+
+
+
+

2.2.1. Description

+
+

uploads of artifact to VF operation workflow

+
+
+
+

2.2.2. Parameters

+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionSchema
+

Header

+
+

Accept
+optional

+
+

Determines the format of the body of the response

+
+

string

+
+

Header

+
+

Authorization
+required

+
+

The username and password

+
+

string

+
+

Header

+
+

Content-MD5
+required

+
+

The value for this header must be the MD5 checksum over the whole json body

+
+

string

+
+

Header

+
+

Content-Type
+required

+
+

Determines the format of the body of the request

+
+

string

+
+

Header

+
+

USER_ID
+required

+
+

The user ID of the DCAE Designer. This user must also have Designer role in SDC

+
+

string

+
+

Header

+
+

X-ECOMP-InstanceID
+required

+
+

X-ECOMP-InstanceID header

+
+

string

+
+

Header

+
+

X-ECOMP-RequestID
+optional

+
+

X-ECOMP-RequestID header

+
+

string

+
+

Path

+
+

artifactUUID
+required

+
+

The uuid of the artifact

+
+

string

+
+

Path

+
+

operationUUID
+required

+
+

The uuid of the operation

+
+

string

+
+

Path

+
+

uuid
+required

+
+

The uuid of the asset as published in the metadata

+
+

string

+
+

Body

+
+

body
+required

+
+

json describe the artifact

+
+ +
+
+

2.2.3. Responses

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema
+

200

+
+

Artifact uploaded

+
+

400

+
+

Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301

+
+

No Content

+
+

401

+
+

ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002

+
+

No Content

+
+

403

+
+

ECOMP component is not authorized - POL5003

+
+

No Content

+
+

404

+
+

Specified resource is not found - SVC4063

+
+

No Content

+
+

405

+
+

Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050

+
+

No Content

+
+

500

+
+

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

+
+

No Content

+
+ +
+
+

2.2.4. Produces

+
+
    +
  • +

    application/json

    +
    • +
+
+
+
+

2.2.5. Tags

+
+
    +
  • +

    Artifact External Servlet

    +
    • +
+
+
+
+
+

2.3. Download service artifact

+
+
+
GET /v1/catalog/services/{serviceName}/{serviceVersion}/artifacts/{artifactName}
+
+
+
+

2.3.1. Description

+
+

Returns downloaded artifact

+
+
+
+

2.3.2. Parameters

+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionSchema
+

Header

+
+

Accept
+optional

+
+

Determines the format of the body of the response

+
+

string

+
+

Header

+
+

Authorization
+required

+
+

The username and password

+
+

string

+
+

Header

+
+

X-ECOMP-InstanceID
+required

+
+

X-ECOMP-InstanceID header

+
+

string

+
+

Header

+
+

X-ECOMP-RequestID
+optional

+
+

X-ECOMP-RequestID header

+
+

string

+
+

Path

+
+

artifactName
+required

+
+

string

+
+

Path

+
+

serviceName
+required

+
+

string

+
+

Path

+
+

serviceVersion
+required

+
+

string

+
+ +
+
+

2.3.3. Responses

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema
+

200

+
+

The artifact is found and streamed.

+
+

string

+
+

400

+
+

Missing X-ECOMP-InstanceID HTTP header - POL5001

+
+

No Content

+
+

401

+
+

ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002

+
+

No Content

+
+

403

+
+

ECOMP component is not authorized - POL5003

+
+

No Content

+
+

404

+
+

Specified artifact is not found - SVC4505

+
+

No Content

+
+

405

+
+

Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050

+
+

No Content

+
+

500

+
+

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

+
+

No Content

+
+ +
+
+

2.3.4. Consumes

+
+
    +
  • +

    application/json

    +
    • +
+
+
+
+

2.3.5. Produces

+
+
    +
  • +

    application/octet-stream

    +
    • +
+
+
+
+

2.3.6. Tags

+
+
    +
  • +

    Distribution Catalog Servlet

    +
    • +
+
+
+
+
+

2.4. Download resource instance artifact

+
+
+
GET /v1/catalog/services/{serviceName}/{serviceVersion}/resourceInstances/{resourceInstanceName}/artifacts/{artifactName}
+
+
+
+

2.4.1. Description

+
+

Returns downloaded artifact

+
+
+
+

2.4.2. Parameters

+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionSchema
+

Header

+
+

Accept
+optional

+
+

Determines the format of the body of the response

+
+

string

+
+

Header

+
+

Authorization
+required

+
+

The username and password

+
+

string

+
+

Header

+
+

X-ECOMP-InstanceID
+required

+
+

X-ECOMP-InstanceID header

+
+

string

+
+

Header

+
+

X-ECOMP-RequestID
+optional

+
+

X-ECOMP-RequestID header

+
+

string

+
+

Path

+
+

artifactName
+required

+
+

string

+
+

Path

+
+

resourceInstanceName
+required

+
+

string

+
+

Path

+
+

serviceName
+required

+
+

string

+
+

Path

+
+

serviceVersion
+required

+
+

string

+
+ +
+
+

2.4.3. Responses

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema
+

200

+
+

The artifact is found and streamed.

+
+

string

+
+

400

+
+

Missing X-ECOMP-InstanceID HTTP header - POL5001

+
+

No Content

+
+

401

+
+

ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002

+
+

No Content

+
+

403

+
+

ECOMP component is not authorized - POL5003

+
+

No Content

+
+

404

+
+

Specified artifact is not found - SVC4505

+
+

No Content

+
+

405

+
+

Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050

+
+

No Content

+
+

500

+
+

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

+
+

No Content

+
+ +
+
+

2.4.4. Consumes

+
+
    +
  • +

    application/json

    +
    • +
+
+
+
+

2.4.5. Produces

+
+
    +
  • +

    application/octet-stream

    +
    • +
+
+
+
+

2.4.6. Tags

+
+
    +
  • +

    Distribution Catalog Servlet

    +
    • +
+
+
+
+
+

2.5. Download resource artifact

+
+
+
GET /v1/catalog/services/{serviceName}/{serviceVersion}/resources/{resourceName}/{resourceVersion}/artifacts/{artifactName}
+
+
+
+

2.5.1. Description

+
+

Returns downloaded artifact

+
+
+
+

2.5.2. Parameters

+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionSchema
+

Header

+
+

Accept
+optional

+
+

Determines the format of the body of the response

+
+

string

+
+

Header

+
+

Authorization
+required

+
+

The username and password

+
+

string

+
+

Header

+
+

X-ECOMP-InstanceID
+required

+
+

X-ECOMP-InstanceID header

+
+

string

+
+

Header

+
+

X-ECOMP-RequestID
+optional

+
+

X-ECOMP-RequestID header

+
+

string

+
+

Path

+
+

artifactName
+required

+
+

string

+
+

Path

+
+

resourceName
+required

+
+

string

+
+

Path

+
+

resourceVersion
+required

+
+

string

+
+

Path

+
+

serviceName
+required

+
+

string

+
+

Path

+
+

serviceVersion
+required

+
+

string

+
+ +
+
+

2.5.3. Responses

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema
+

200

+
+

The artifact is found and streamed.

+
+

string

+
+

400

+
+

Missing X-ECOMP-InstanceID HTTP header - POL5001

+
+

No Content

+
+

401

+
+

ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002

+
+

No Content

+
+

403

+
+

ECOMP component is not authorized - POL5003

+
+

No Content

+
+

404

+
+

Specified artifact is not found - SVC4505

+
+

No Content

+
+

405

+
+

Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050

+
+

No Content

+
+

500

+
+

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

+
+

No Content

+
+ +
+
+

2.5.4. Consumes

+
+
    +
  • +

    application/json

    +
    • +
+
+
+
+

2.5.5. Produces

+
+
    +
  • +

    application/octet-stream

    +
    • +
+
+
+
+

2.5.6. Tags

+
+
    +
  • +

    Distribution Catalog Servlet

    +
    • +
+
+
+
+
+

2.6. activate a service

+
+
+
POST /v1/catalog/services/{serviceUUID}/distribution/{opEnvId}/activate
+
+
+
+

2.6.1. Description

+
+

Activates a service

+
+
+
+

2.6.2. Parameters

+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionSchema
+

Header

+
+

Accept
+optional

+
+

Determines the format of the body of the response

+
+

string

+
+

Header

+
+

Authorization
+required

+
+

The username and password

+
+

string

+
+

Header

+
+

Content-Type
+required

+
+

Determines the format of the body of the request

+
+

string

+
+

Header

+
+

USER_ID
+required

+
+

The user id

+
+

string

+
+

Header

+
+

X-ECOMP-InstanceID
+required

+
+

X-ECOMP-InstanceID header

+
+

string

+
+

Header

+
+

X-ECOMP-RequestID
+optional

+
+

X-ECOMP-RequestID header

+
+

string

+
+

Path

+
+

opEnvId
+required

+
+

The operational environment on which to activate the service on

+
+

string

+
+

Path

+
+

serviceUUID
+required

+
+

The serviceUUid to activate

+
+

string

+
+

Body

+
+

body
+optional

+
+

string

+
+ +
+
+

2.6.3. Responses

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema
+

202

+
+

ECOMP component is authenticated and required service may be distributed

+
+

No Content

+
+

400

+
+

The resource name is missing in the request body - SVC4062

+
+

No Content

+
+

401

+
+

ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002

+
+

No Content

+
+

403

+
+

ECOMP component is not authorized - POL5003

+
+

No Content

+
+

404

+
+

Error: Requested %1 (uuid) resource was not found - SVC4063

+
+

No Content

+
+

405

+
+

Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050

+
+

No Content

+
+

409

+
+

Service state is invalid for this action

+
+

No Content

+
+

500

+
+

The request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000

+
+

No Content

+
+

502

+
+

The server was acting as a gateway or proxy and received an invalid response from the upstream server

+
+

No Content

+
+ +
+
+

2.6.4. Consumes

+
+
    +
  • +

    application/json

    +
    • +
+
+
+
+

2.6.5. Produces

+
+
    +
  • +

    application/json

    +
    • +
+
+
+
+

2.6.6. Tags

+
+
    +
  • +

    Service Activation External Servlet

    +
    • +
+
+
+
+
+

2.7. creates a resource

+
+
+
POST /v1/catalog/{assetType}
+
+
+
+

2.7.1. Description

+
+

Creates a resource

+
+
+
+

2.7.2. Parameters

+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionSchema
+

Header

+
+

Accept
+optional

+
+

Determines the format of the body of the response

+
+

string

+
+

Header

+
+

Authorization
+required

+
+

The username and password

+
+

string

+
+

Header

+
+

Content-Type
+required

+
+

Determines the format of the body of the request

+
+

string

+
+

Header

+
+

USER_ID
+required

+
+

The user id

+
+

string

+
+

Header

+
+

X-ECOMP-InstanceID
+required

+
+

X-ECOMP-InstanceID header

+
+

string

+
+

Header

+
+

X-ECOMP-RequestID
+optional

+
+

X-ECOMP-RequestID header

+
+

string

+
+

Path

+
+

assetType
+required

+
+

The requested asset type

+
+

enum (resources, services)

+
+

Body

+
+

body
+required

+
+

json describe the created resource

+
+ +
+
+

2.7.3. Responses

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema
+

200

+
+

ECOMP component is authenticated and Asset created

+
+

400

+
+

Create VFCMT request: VFCMT name exceeds character limit - SVC4073

+
+

No Content

+
+

401

+
+

ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002

+
+

No Content

+
+

403

+
+

ECOMP component is not authorized - POL5003

+
+

No Content

+
+

404

+
+

Error: Requested %1 (uuid) resource was not found - SVC4063

+
+

No Content

+
+

405

+
+

Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050

+
+

No Content

+
+

500

+
+

The GET request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000

+
+

No Content

+
+ +
+
+

2.7.4. Consumes

+
+
    +
  • +

    application/json

    +
    • +
+
+
+
+

2.7.5. Produces

+
+
    +
  • +

    application/json

    +
    • +
+
+
+
+

2.7.6. Tags

+
+
    +
  • +

    CRUD External Servlet

    +
    • +
+
+
+
+
+

2.8. Fetch list of assets

+
+
+
GET /v1/catalog/{assetType}
+
+
+
+

2.8.1. Description

+
+

Returns list of assets

+
+
+
+

2.8.2. Parameters

+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionSchema
+

Header

+
+

Accept
+optional

+
+

Determines the format of the body of the response

+
+

string

+
+

Header

+
+

Authorization
+required

+
+

The username and password

+
+

string

+
+

Header

+
+

X-ECOMP-InstanceID
+required

+
+

X-ECOMP-InstanceID header

+
+

string

+
+

Header

+
+

X-ECOMP-RequestID
+optional

+
+

X-ECOMP-RequestID header

+
+

string

+
+

Path

+
+

assetType
+required

+
+

The requested asset type

+
+

enum (resources, services)

+
+

Query

+
+

category
+optional

+
+

The filter key (resourceType only for resources)

+
+

string

+
+

Query

+
+

distributionStatus
+optional

+
+

The filter key (resourceType only for resources)

+
+

string

+
+

Query

+
+

resourceType
+optional

+
+

The filter key (resourceType only for resources)

+
+

string

+
+

Query

+
+

subCategory
+optional

+
+

The filter key (resourceType only for resources)

+
+

string

+
+ +
+
+

2.8.3. Responses

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema
+

200

+
+

ECOMP component is authenticated and list of Catalog Assets Metadata is returned

+
+

< AssetMetadata > array

+
+

400

+
+

Missing X-ECOMP-InstanceID HTTP header - POL5001

+
+

No Content

+
+

401

+
+

ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002

+
+

No Content

+
+

403

+
+

ECOMP component is not authorized - POL5003

+
+

No Content

+
+

405

+
+

Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050

+
+

No Content

+
+

500

+
+

The GET request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000

+
+

No Content

+
+ +
+
+

2.8.4. Produces

+
+
    +
  • +

    application/json

    +
    • +
+
+
+
+

2.8.5. Tags

+
+
    +
  • +

    Asset Metadata External Servlet

    +
    • +
+
+
+
+
+

2.9. uploads of artifact to a resource or service

+
+
+
POST /v1/catalog/{assetType}/{uuid}/artifacts
+
+
+
+

2.9.1. Description

+
+

uploads of artifact to a resource or service

+
+
+
+

2.9.2. Parameters

+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionSchema
+

Header

+
+

Accept
+optional

+
+

Determines the format of the body of the response

+
+

string

+
+

Header

+
+

Authorization
+required

+
+

The username and password

+
+

string

+
+

Header

+
+

Content-MD5
+required

+
+

The value for this header must be the MD5 checksum over the whole json body

+
+

string

+
+

Header

+
+

Content-Type
+required

+
+

Determines the format of the body of the request

+
+

string

+
+

Header

+
+

USER_ID
+required

+
+

The user ID of the DCAE Designer. This user must also have Designer role in SDC

+
+

string

+
+

Header

+
+

X-ECOMP-InstanceID
+required

+
+

X-ECOMP-InstanceID header

+
+

string

+
+

Header

+
+

X-ECOMP-RequestID
+optional

+
+

X-ECOMP-RequestID header

+
+

string

+
+

Path

+
+

assetType
+required

+
+

The requested asset type

+
+

enum (resources, services)

+
+

Path

+
+

uuid
+required

+
+

The uuid of the asset as published in the metadata

+
+

string

+
+

Body

+
+

body
+required

+
+

json describe the artifact

+
+ +
+
+

2.9.3. Responses

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema
+

200

+
+

Artifact uploaded

+
+

400

+
+

Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301

+
+

No Content

+
+

401

+
+

ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002

+
+

No Content

+
+

403

+
+

ECOMP component is not authorized - POL5003

+
+

No Content

+
+

404

+
+

Specified resource is not found - SVC4063

+
+

No Content

+
+

405

+
+

Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050

+
+

No Content

+
+

500

+
+

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

+
+

No Content

+
+ +
+
+

2.9.4. Produces

+
+
    +
  • +

    application/json

    +
    • +
+
+
+
+

2.9.5. Tags

+
+
    +
  • +

    Artifact External Servlet

    +
    • +
+
+
+
+
+

2.10. updates an artifact on a resource or service

+
+
+
POST /v1/catalog/{assetType}/{uuid}/artifacts/{artifactUUID}
+
+
+
+

2.10.1. Description

+
+

uploads of artifact to a resource or service

+
+
+
+

2.10.2. Parameters

+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionSchema
+

Header

+
+

Accept
+optional

+
+

Determines the format of the body of the response

+
+

string

+
+

Header

+
+

Authorization
+required

+
+

The username and password

+
+

string

+
+

Header

+
+

Content-MD5
+required

+
+

The value for this header must be the MD5 checksum over the whole json body

+
+

string

+
+

Header

+
+

Content-Type
+required

+
+

Determines the format of the body of the request

+
+

string

+
+

Header

+
+

USER_ID
+required

+
+

The user ID of the DCAE Designer. This user must also have Designer role in SDC

+
+

string

+
+

Header

+
+

X-ECOMP-InstanceID
+required

+
+

X-ECOMP-InstanceID header

+
+

string

+
+

Header

+
+

X-ECOMP-RequestID
+optional

+
+

X-ECOMP-RequestID header

+
+

string

+
+

Path

+
+

artifactUUID
+required

+
+

The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation

+
+

string

+
+

Path

+
+

assetType
+required

+
+

The requested asset type

+
+

enum (resources, services)

+
+

Path

+
+

uuid
+required

+
+

The uuid of the asset as published in the metadata

+
+

string

+
+

Body

+
+

body
+required

+
+

json describe the artifact

+
+ +
+
+

2.10.3. Responses

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema
+

200

+
+

Artifact updated

+
+

400

+
+

Artifact name is missing in input - SVC4128

+
+

No Content

+
+

401

+
+

ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002

+
+

No Content

+
+

403

+
+

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

+
+

No Content

+
+

404

+
+

Specified resource is not found - SVC4063

+
+

No Content

+
+

405

+
+

Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050

+
+

No Content

+
+

409

+
+

Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301

+
+

No Content

+
+

500

+
+

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

+
+

No Content

+
+ +
+
+

2.10.4. Produces

+
+
    +
  • +

    application/json

    +
    • +
+
+
+
+

2.10.5. Tags

+
+
    +
  • +

    Artifact External Servlet

    +
    • +
+
+
+
+
+

2.11. Download component artifact

+
+
+
GET /v1/catalog/{assetType}/{uuid}/artifacts/{artifactUUID}
+
+
+
+

2.11.1. Description

+
+

Returns downloaded artifact

+
+
+
+

2.11.2. Parameters

+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionSchema
+

Header

+
+

Accept
+optional

+
+

Determines the format of the body of the response

+
+

string

+
+

Header

+
+

Authorization
+required

+
+

The username and password

+
+

string

+
+

Header

+
+

USER_ID
+required

+
+

The user ID of the DCAE Designer. This user must also have Designer role in SDC

+
+

string

+
+

Header

+
+

X-ECOMP-InstanceID
+required

+
+

X-ECOMP-InstanceID header

+
+

string

+
+

Header

+
+

X-ECOMP-RequestID
+optional

+
+

X-ECOMP-RequestID header

+
+

string

+
+

Path

+
+

artifactUUID
+required

+
+

The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation

+
+

string

+
+

Path

+
+

assetType
+required

+
+

The requested asset type

+
+

enum (resources, services)

+
+

Path

+
+

uuid
+required

+
+

The uuid of the asset as published in the metadata

+
+

string

+
+ +
+
+

2.11.3. Responses

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema
+

200

+
+

Artifact downloaded

+
+

string

+
+

400

+
+

Missing X-ECOMP-InstanceID HTTP header - POL5001

+
+

No Content

+
+

401

+
+

ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002

+
+

No Content

+
+

403

+
+

ECOMP component is not authorized - POL5003

+
+

No Content

+
+

404

+
+

Artifact was not found - SVC4505

+
+

No Content

+
+

405

+
+

Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050

+
+

No Content

+
+

500

+
+

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

+
+

No Content

+
+ +
+
+

2.11.4. Produces

+
+
    +
  • +

    application/octet-stream

    +
    • +
+
+
+
+

2.11.5. Tags

+
+
    +
  • +

    Artifact External Servlet

    +
    • +
+
+
+
+
+

2.12. deletes an artifact of a resource or service

+
+
+
DELETE /v1/catalog/{assetType}/{uuid}/artifacts/{artifactUUID}
+
+
+
+

2.12.1. Description

+
+

deletes an artifact of a resource or service

+
+
+
+

2.12.2. Parameters

+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionSchema
+

Header

+
+

Accept
+optional

+
+

Determines the format of the body of the response

+
+

string

+
+

Header

+
+

Authorization
+required

+
+

The username and password

+
+

string

+
+

Header

+
+

USER_ID
+required

+
+

The user ID of the DCAE Designer. This user must also have Designer role in SDC

+
+

string

+
+

Header

+
+

X-ECOMP-InstanceID
+required

+
+

X-ECOMP-InstanceID header

+
+

string

+
+

Header

+
+

X-ECOMP-RequestID
+optional

+
+

X-ECOMP-RequestID header

+
+

string

+
+

Path

+
+

artifactUUID
+required

+
+

The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation

+
+

string

+
+

Path

+
+

assetType
+required

+
+

The requested asset type

+
+

enum (resources, services)

+
+

Path

+
+

uuid
+required

+
+

The uuid of the asset as published in the metadata

+
+

string

+
+ +
+
+

2.12.3. Responses

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema
+

200

+
+

Artifact deleted

+
+

400

+
+

Artifact name is missing in input - SVC4128

+
+

No Content

+
+

401

+
+

ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002

+
+

No Content

+
+

403

+
+

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

+
+

No Content

+
+

404

+
+

Specified resource is not found - SVC4063

+
+

No Content

+
+

405

+
+

Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050

+
+

No Content

+
+

409

+
+

Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301

+
+

No Content

+
+

500

+
+

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

+
+

No Content

+
+ +
+
+

2.12.4. Produces

+
+
    +
  • +

    application/json

    +
    • +
+
+
+
+

2.12.5. Tags

+
+
    +
  • +

    Artifact External Servlet

    +
    • +
+
+
+
+
+

2.13. Change Resource lifecycle State

+
+
+
POST /v1/catalog/{assetType}/{uuid}/lifecycleState/{lifecycleOperation}
+
+
+
+

2.13.1. Parameters

+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionSchema
+

Header

+
+

Accept
+optional

+
+

Determines the format of the body of the response

+
+

string

+
+

Header

+
+

Authorization
+required

+
+

The username and password

+
+

string

+
+

Header

+
+

Content-Type
+required

+
+

Determines the format of the body of the request

+
+

string

+
+

Header

+
+

USER_ID
+required

+
+

The user id

+
+

string

+
+

Header

+
+

X-ECOMP-InstanceID
+required

+
+

X-ECOMP-InstanceID header

+
+

string

+
+

Header

+
+

X-ECOMP-RequestID
+optional

+
+

X-ECOMP-RequestID header

+
+

string

+
+

Path

+
+

assetType
+required

+
+

validValues: resources / services

+
+

enum (resources, services)

+
+

Path

+
+

lifecycleOperation
+required

+
+

enum (checkout, checkin)

+
+

Path

+
+

uuid
+required

+
+

id of component to be changed

+
+

string

+
+

Body

+
+

body
+required

+
+

userRemarks - Short description (free text) about the asset version being changed

+
+ +
+
+

2.13.2. Responses

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema
+

200

+
+

Resource state changed

+
+

400

+
+

Missing X-ECOMP-InstanceID HTTP header - POL5001

+
+

No Content

+
+

401

+
+

ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002

+
+

No Content

+
+

403

+
+

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

+
+

No Content

+
+

404

+
+

Error: Requested %1 (uuid) resource was not found - SVC4063

+
+

No Content

+
+

405

+
+

Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050

+
+

No Content

+
+

500

+
+

The GET request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000

+
+

No Content

+
+ +
+
+

2.13.3. Consumes

+
+
    +
  • +

    application/json

    +
    • +
+
+
+
+

2.13.4. Produces

+
+
    +
  • +

    application/json

    +
    • +
+
+
+
+

2.13.5. Tags

+
+
    +
  • +

    CRUD External Servlet

    +
    • +
+
+
+
+
+

2.14. Detailed metadata of asset by uuid

+
+
+
GET /v1/catalog/{assetType}/{uuid}/metadata
+
+
+
+

2.14.1. Description

+
+

Returns detailed metadata of an asset by uuid

+
+
+
+

2.14.2. Parameters

+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionSchema
+

Header

+
+

Accept
+optional

+
+

Determines the format of the body of the response

+
+

string

+
+

Header

+
+

Authorization
+required

+
+

The username and password

+
+

string

+
+

Header

+
+

X-ECOMP-InstanceID
+required

+
+

X-ECOMP-InstanceID header

+
+

string

+
+

Header

+
+

X-ECOMP-RequestID
+optional

+
+

X-ECOMP-RequestID header

+
+

string

+
+

Path

+
+

assetType
+required

+
+

The requested asset type

+
+

enum (resources, services)

+
+

Path

+
+

uuid
+required

+
+

The requested asset uuid

+
+

string

+
+ +
+
+

2.14.3. Responses

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema
+

200

+
+

ECOMP component is authenticated and list of Catalog Assets Metadata is returned

+
+

< AssetMetadata > array

+
+

400

+
+

Missing X-ECOMP-InstanceID HTTP header - POL5001

+
+

No Content

+
+

401

+
+

ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002

+
+

No Content

+
+

403

+
+

ECOMP component is not authorized - POL5003

+
+

No Content

+
+

404

+
+

Error: Requested %1 (uuid) resource was not found - SVC4063

+
+

No Content

+
+

405

+
+

Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050

+
+

No Content

+
+

500

+
+

The GET request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000

+
+

No Content

+
+ +
+
+

2.14.4. Produces

+
+
    +
  • +

    application/json

    +
    • +
+
+
+
+

2.14.5. Tags

+
+
    +
  • +

    Asset Metadata External Servlet

    +
    • +
+
+
+
+
+

2.15. uploads an artifact to a resource instance

+
+
+
POST /v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceName}/artifacts
+
+
+
+

2.15.1. Description

+
+

uploads an artifact to a resource instance

+
+
+
+

2.15.2. Parameters

+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionSchema
+

Header

+
+

Accept
+optional

+
+

Determines the format of the body of the response

+
+

string

+
+

Header

+
+

Authorization
+required

+
+

The username and password

+
+

string

+
+

Header

+
+

Content-MD5
+required

+
+

The value for this header must be the MD5 checksum over the whole json body

+
+

string

+
+

Header

+
+

Content-Type
+required

+
+

Determines the format of the body of the request

+
+

string

+
+

Header

+
+

USER_ID
+required

+
+

The user ID of the DCAE Designer. This user must also have Designer role in SDC

+
+

string

+
+

Header

+
+

X-ECOMP-InstanceID
+required

+
+

X-ECOMP-InstanceID header

+
+

string

+
+

Header

+
+

X-ECOMP-RequestID
+optional

+
+

X-ECOMP-RequestID header

+
+

string

+
+

Path

+
+

assetType
+required

+
+

The requested asset type

+
+

enum (resources, services)

+
+

Path

+
+

resourceInstanceName
+required

+
+

The component instance name (as publishedin the response of the detailed query)

+
+

string

+
+

Path

+
+

uuid
+required

+
+

The uuid of the asset as published in the metadata

+
+

string

+
+

Body

+
+

body
+required

+
+

json describe the artifact

+
+ +
+
+

2.15.3. Responses

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema
+

200

+
+

Artifact uploaded

+
+

400

+
+

Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301

+
+

No Content

+
+

401

+
+

ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002

+
+

No Content

+
+

403

+
+

ECOMP component is not authorized - POL5003

+
+

No Content

+
+

404

+
+

Specified resource is not found - SVC4063

+
+

No Content

+
+

405

+
+

Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050

+
+

No Content

+
+

500

+
+

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

+
+

No Content

+
+ +
+
+

2.15.4. Produces

+
+
    +
  • +

    application/json

    +
    • +
+
+
+
+

2.15.5. Tags

+
+
    +
  • +

    Artifact External Servlet

    +
    • +
+
+
+
+
+

2.16. updates an artifact on a resource instance

+
+
+
POST /v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceName}/artifacts/{artifactUUID}
+
+
+
+

2.16.1. Description

+
+

uploads of artifact to a resource or service

+
+
+
+

2.16.2. Parameters

+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionSchema
+

Header

+
+

Accept
+optional

+
+

Determines the format of the body of the response

+
+

string

+
+

Header

+
+

Authorization
+required

+
+

The username and password

+
+

string

+
+

Header

+
+

Content-MD5
+required

+
+

The value for this header must be the MD5 checksum over the whole json body

+
+

string

+
+

Header

+
+

Content-Type
+required

+
+

Determines the format of the body of the request

+
+

string

+
+

Header

+
+

USER_ID
+required

+
+

The user ID of the DCAE Designer. This user must also have Designer role in SDC

+
+

string

+
+

Header

+
+

X-ECOMP-InstanceID
+required

+
+

X-ECOMP-InstanceID header

+
+

string

+
+

Header

+
+

X-ECOMP-RequestID
+optional

+
+

X-ECOMP-RequestID header

+
+

string

+
+

Path

+
+

artifactUUID
+required

+
+

The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation

+
+

string

+
+

Path

+
+

assetType
+required

+
+

The requested asset type

+
+

enum (resources, services)

+
+

Path

+
+

resourceInstanceName
+required

+
+

The component instance name (as publishedin the response of the detailed query)

+
+

string

+
+

Path

+
+

uuid
+required

+
+

The uuid of the asset as published in the metadata

+
+

string

+
+

Body

+
+

body
+required

+
+

json describe the artifact

+
+ +
+
+

2.16.3. Responses

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema
+

200

+
+

Artifact updated

+
+

400

+
+

Artifact name is missing in input - SVC4128

+
+

No Content

+
+

401

+
+

ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002

+
+

No Content

+
+

403

+
+

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

+
+

No Content

+
+

404

+
+

Specified resource is not found - SVC4063

+
+

No Content

+
+

405

+
+

Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050

+
+

No Content

+
+

409

+
+

Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301

+
+

No Content

+
+

500

+
+

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

+
+

No Content

+
+ +
+
+

2.16.4. Produces

+
+
    +
  • +

    application/json

    +
    • +
+
+
+
+

2.16.5. Tags

+
+
    +
  • +

    Artifact External Servlet

    +
    • +
+
+
+
+
+

2.17. Download resource instance artifact

+
+
+
GET /v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceName}/artifacts/{artifactUUID}
+
+
+
+

2.17.1. Description

+
+

Returns downloaded artifact

+
+
+
+

2.17.2. Parameters

+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionSchema
+

Header

+
+

Accept
+optional

+
+

Determines the format of the body of the response

+
+

string

+
+

Header

+
+

Authorization
+required

+
+

The username and password

+
+

string

+
+

Header

+
+

USER_ID
+required

+
+

The user ID of the DCAE Designer. This user must also have Designer role in SDC

+
+

string

+
+

Header

+
+

X-ECOMP-InstanceID
+required

+
+

X-ECOMP-InstanceID header

+
+

string

+
+

Header

+
+

X-ECOMP-RequestID
+optional

+
+

X-ECOMP-RequestID header

+
+

string

+
+

Path

+
+

artifactUUID
+required

+
+

The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation

+
+

string

+
+

Path

+
+

assetType
+required

+
+

The requested asset type

+
+

enum (resources, services)

+
+

Path

+
+

resourceInstanceName
+required

+
+

The component instance name (as publishedin the response of the detailed query)

+
+

string

+
+

Path

+
+

uuid
+required

+
+

The uuid of the asset as published in the metadata

+
+

string

+
+ +
+
+

2.17.3. Responses

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema
+

200

+
+

Artifact downloaded

+
+

string

+
+

400

+
+

Missing X-ECOMP-InstanceID HTTP header - POL5001

+
+

No Content

+
+

401

+
+

ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002

+
+

No Content

+
+

403

+
+

ECOMP component is not authorized - POL5003

+
+

No Content

+
+

404

+
+

Artifact was not found - SVC4505

+
+

No Content

+
+

405

+
+

Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050

+
+

No Content

+
+

500

+
+

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

+
+

No Content

+
+ +
+
+

2.17.4. Produces

+
+
    +
  • +

    application/octet-stream

    +
    • +
+
+
+
+

2.17.5. Tags

+
+
    +
  • +

    Artifact External Servlet

    +
    • +
+
+
+
+
+

2.18. deletes an artifact of a resource insatnce

+
+
+
DELETE /v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceName}/artifacts/{artifactUUID}
+
+
+
+

2.18.1. Description

+
+

deletes an artifact of a resource insatnce

+
+
+
+

2.18.2. Parameters

+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionSchema
+

Header

+
+

Accept
+optional

+
+

Determines the format of the body of the response

+
+

string

+
+

Header

+
+

Authorization
+required

+
+

The username and password

+
+

string

+
+

Header

+
+

USER_ID
+required

+
+

The user ID of the DCAE Designer. This user must also have Designer role in SDC

+
+

string

+
+

Header

+
+

X-ECOMP-InstanceID
+required

+
+

X-ECOMP-InstanceID header

+
+

string

+
+

Header

+
+

X-ECOMP-RequestID
+optional

+
+

X-ECOMP-RequestID header

+
+

string

+
+

Path

+
+

artifactUUID
+required

+
+

The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation

+
+

string

+
+

Path

+
+

assetType
+required

+
+

The requested asset type

+
+

enum (resources, services)

+
+

Path

+
+

resourceInstanceName
+required

+
+

The component instance name (as publishedin the response of the detailed query)

+
+

string

+
+

Path

+
+

uuid
+required

+
+

The uuid of the asset as published in the metadata

+
+

string

+
+ +
+
+

2.18.3. Responses

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema
+

200

+
+

Artifact deleted

+
+

400

+
+

Artifact name is missing in input - SVC4128

+
+

No Content

+
+

401

+
+

ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002

+
+

No Content

+
+

403

+
+

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

+
+

No Content

+
+

404

+
+

Specified resource is not found - SVC4063

+
+

No Content

+
+

405

+
+

Method Not Allowed: Invalid HTTP method type used (PUT,DELETE,POST will be rejected) - POL4050

+
+

No Content

+
+

409

+
+

Restricted Operation – the user provided does not have role of Designer or the asset is being used by another designer - SVC4301

+
+

No Content

+
+

500

+
+

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

+
+

No Content

+
+ +
+
+

2.18.4. Produces

+
+
    +
  • +

    application/json

    +
    • +
+
+
+
+

2.18.5. Tags

+
+
    +
  • +

    Artifact External Servlet

    +
    • +
+
+
+
+
+

2.19. Fetch assets CSAR

+
+
+
GET /v1/catalog/{assetType}/{uuid}/toscaModel
+
+
+
+

2.19.1. Description

+
+

Returns asset csar

+
+
+
+

2.19.2. Parameters

+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionSchema
+

Header

+
+

Accept
+optional

+
+

Determines the format of the body of the response

+
+

string

+
+

Header

+
+

Authorization
+required

+
+

The username and password

+
+

string

+
+

Header

+
+

X-ECOMP-InstanceID
+required

+
+

X-ECOMP-InstanceID header

+
+

string

+
+

Header

+
+

X-ECOMP-RequestID
+optional

+
+

X-ECOMP-RequestID header

+
+

string

+
+

Path

+
+

assetType
+required

+
+

The requested asset type

+
+

enum (resources, services)

+
+

Path

+
+

uuid
+required

+
+

The requested asset uuid

+
+

string

+
+ +
+
+

2.19.3. Responses

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema
+

200

+
+

ECOMP component is authenticated and list of Catalog Assets Metadata is returned

+
+

string

+
+

400

+
+

Missing X-ECOMP-InstanceID HTTP header - POL5001

+
+

No Content

+
+

401

+
+

ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002

+
+

No Content

+
+

403

+
+

ECOMP component is not authorized - POL5003

+
+

No Content

+
+

404

+
+

Error: Requested %1 (uuid) resource was not found - SVC4063

+
+

No Content

+
+

405

+
+

Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050

+
+

No Content

+
+

500

+
+

The GET request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000

+
+

No Content

+
+ +
+
+

2.19.4. Produces

+
+
    +
  • +

    application/octet-stream

    +
    • +
+
+
+
+

2.19.5. Tags

+
+
    +
  • +

    Asset Metadata External Servlet

    +
    • +
+
+
+
+
+

2.20. UEB Server List

+
+
+
GET /v1/distributionUebCluster
+
+
+
+

2.20.1. Description

+
+

return the available UEB Server List

+
+
+
+

2.20.2. Parameters

+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionSchema
+

Header

+
+

Accept
+optional

+
+

Determines the format of the body of the response

+
+

string

+
+

Header

+
+

Authorization
+required

+
+

The username and password

+
+

string

+
+

Header

+
+

X-ECOMP-InstanceID
+required

+
+

X-ECOMP-InstanceID header

+
+

string

+
+

Header

+
+

X-ECOMP-RequestID
+optional

+
+

X-ECOMP-RequestID header

+
+

string

+
+ +
+
+

2.20.3. Responses

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema
+

200

+
+

ECOMP component is authenticated and list of Cambria API server’s FQDNs is returned

+
+

400

+
+

Missing X-ECOMP-InstanceID HTTP header - POL5001

+
+

No Content

+
+

401

+
+

ECOMP component should authenticate itself and to re-send again HTTP request with its credentials for Basic Authentication - POL5002

+
+

No Content

+
+

403

+
+

ECOMP component is not authorized - POL5003

+
+

No Content

+
+

405

+
+

Method Not Allowed: Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050

+
+

No Content

+
+

500

+
+

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

+
+

No Content

+
+ +
+
+

2.20.4. Consumes

+
+
    +
  • +

    application/json

    +
    • +
+
+
+
+

2.20.5. Produces

+
+
    +
  • +

    application/json

    +
    • +
+
+
+
+

2.20.6. Tags

+
+
    +
  • +

    Distribution Servlet

    +
    • +
+
+
+
+
+

2.21. Subscription status

+
+
+
POST /v1/registerForDistribution
+
+
+
+

2.21.1. Description

+
+

Subscribes for distribution notifications

+
+
+
+

2.21.2. Parameters

+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionSchema
+

Header

+
+

Accept
+optional

+
+

Determines the format of the body of the response

+
+

string

+
+

Header

+
+

Authorization
+required

+
+

The username and password

+
+

string

+
+

Header

+
+

Content-Length
+required

+
+

Length of the request body

+
+

string

+
+

Header

+
+

Content-Type
+required

+
+

Determines the format of the body of the request

+
+

string

+
+

Header

+
+

X-ECOMP-InstanceID
+required

+
+

X-ECOMP-InstanceID header

+
+

string

+
+

Header

+
+

X-ECOMP-RequestID
+optional

+
+

X-ECOMP-RequestID header

+
+

string

+
+

Body

+
+

requestJson
+required

+
+

json describe the artifact

+
+ +
+
+

2.21.3. Responses

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema
+

200

+
+

ECOMP component is successfully registered for distribution

+
+

400

+
+

Invalid Body : Specified distrEnvName doesn’t exist - POL4137

+
+

No Content

+
+

401

+
+

ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002

+
+

No Content

+
+

403

+
+

ECOMP component is not authorized - POL5003

+
+

No Content

+
+

405

+
+

Method Not Allowed : Invalid HTTP method type used to register for distribution ( PUT,DELETE,GET will be rejected) - POL4050

+
+

No Content

+
+

500

+
+

The registration failed due to internal SDC problem or Cambria Service failure ECOMP Component should continue the attempts to register for distribution - POL5000

+
+

No Content

+
+ +
+
+

2.21.4. Consumes

+
+
    +
  • +

    application/json

    +
    • +
+
+
+
+

2.21.5. Produces

+
+
    +
  • +

    application/json

    +
    • +
+
+
+
+

2.21.6. Tags

+
+
    +
  • +

    Distribution Servlet

    +
    • +
+
+
+
+
+

2.22. Subscription status

+
+
+
POST /v1/unRegisterForDistribution
+
+
+
+

2.22.1. Description

+
+

Removes from subscription for distribution notifications

+
+
+
+

2.22.2. Parameters

+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionSchema
+

Header

+
+

Accept
+optional

+
+

Determines the format of the body of the response

+
+

string

+
+

Header

+
+

Authorization
+required

+
+

The username and password

+
+

string

+
+

Header

+
+

Content-Length
+required

+
+

Length of the request body

+
+

string

+
+

Header

+
+

Content-Type
+required

+
+

Determines the format of the body of the request

+
+

string

+
+

Header

+
+

X-ECOMP-InstanceID
+required

+
+

X-ECOMP-InstanceID header

+
+

string

+
+

Header

+
+

X-ECOMP-RequestID
+optional

+
+

X-ECOMP-RequestID header

+
+

string

+
+

Body

+
+

requestJson
+required

+
+

json describe the artifact

+
+ +
+
+

2.22.3. Responses

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema
+

204

+
+

ECOMP component is successfully unregistered

+
+

400

+
+

Invalid Body : Specified distrEnvName doesn’t exist - POL4137

+
+

No Content

+
+

401

+
+

ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002

+
+

No Content

+
+

403

+
+

ECOMP component is not authorized - POL5003

+
+

No Content

+
+

405

+
+

Method Not Allowed : Invalid HTTP method type used to register for distribution ( PUT,DELETE,GET will be rejected) - POL4050

+
+

No Content

+
+

500

+
+

The registration failed due to internal SDC problem or Cambria Service failure ECOMP Component should continue the attempts to register for distribution - POL5000

+
+

No Content

+
+ +
+
+

2.22.4. Consumes

+
+
    +
  • +

    application/json

    +
    • +
+
+
+
+

2.22.5. Produces

+
+
    +
  • +

    application/json

    +
    • +
+
+
+
+

2.22.6. Tags

+
+
    +
  • +

    Distribution Servlet

    +
    • +
+
+
+
+
+
+
+

3. Definitions

+
+
+

3.1. AdditionalInfoParameterInfo

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

empty
+optional

+
+

boolean

+
+

key
+optional

+
+

string

+
+

ownerId
+optional

+
+

string

+
+

uniqueId
+optional

+
+

string

+
+

value
+optional

+
+

string

+
+ +
+
+

3.2. AdditionalInformationDefinition

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

creationTime
+optional

+
+

integer (int64)

+
+

empty
+optional

+
+

boolean

+
+

lastCreatedCounter
+optional

+
+

integer (int32)

+
+

modificationTime
+optional

+
+

integer (int64)

+
+

ownerId
+optional

+
+

string

+
+

parameters
+optional

+
+

parentUniqueId
+optional

+
+

string

+
+

uniqueId
+optional

+
+

string

+
+ +
+
+

3.3. ArtifactDataDefinition

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

apiUrl
+optional

+
+

string

+
+

artifactChecksum
+optional

+
+

string

+
+

artifactCreator
+optional

+
+

string

+
+

artifactDisplayName
+optional

+
+

string

+
+

artifactGroupType
+optional

+
+

enum (INFORMATIONAL, DEPLOYMENT, LIFE_CYCLE, SERVICE_API, TOSCA, OTHER)

+
+

artifactLabel
+optional

+
+

string

+
+

artifactName
+optional

+
+

string

+
+

artifactRef
+optional

+
+

string

+
+

artifactRepository
+optional

+
+

string

+
+

artifactType
+optional

+
+

string

+
+

artifactUUID
+optional

+
+

string

+
+

artifactVersion
+optional

+
+

string

+
+

creationDate
+optional

+
+

integer (int64)

+
+

creatorFullName
+optional

+
+

string

+
+

description
+optional

+
+

string

+
+

duplicated
+optional

+
+

boolean

+
+

empty
+optional

+
+

boolean

+
+

esId
+optional

+
+

string

+
+

generated
+optional

+
+

boolean

+
+

generatedFromId
+optional

+
+

string

+
+

heatParameters
+optional

+
+

heatParamsUpdateDate
+optional

+
+

integer (int64)

+
+

isFromCsar
+optional

+
+

boolean

+
+

lastUpdateDate
+optional

+
+

integer (int64)

+
+

mandatory
+optional

+
+

boolean

+
+

ownerId
+optional

+
+

string

+
+

payloadUpdateDate
+optional

+
+

integer (int64)

+
+

requiredArtifacts
+optional

+
+

< string > array

+
+

serviceApi
+optional

+
+

boolean

+
+

timeout
+optional

+
+

integer (int32)

+
+

uniqueId
+optional

+
+

string

+
+

updaterFullName
+optional

+
+

string

+
+

userIdCreator
+optional

+
+

string

+
+

userIdLastUpdater
+optional

+
+

string

+
+ +
+
+

3.4. ArtifactDefinition

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

apiUrl
+optional

+
+

string

+
+

artifactChecksum
+optional

+
+

string

+
+

artifactCreator
+optional

+
+

string

+
+

artifactDisplayName
+optional

+
+

string

+
+

artifactGroupType
+optional

+
+

enum (INFORMATIONAL, DEPLOYMENT, LIFE_CYCLE, SERVICE_API, TOSCA, OTHER)

+
+

artifactLabel
+optional

+
+

string

+
+

artifactName
+optional

+
+

string

+
+

artifactRef
+optional

+
+

string

+
+

artifactRepository
+optional

+
+

string

+
+

artifactType
+optional

+
+

string

+
+

artifactUUID
+optional

+
+

string

+
+

artifactVersion
+optional

+
+

string

+
+

creationDate
+optional

+
+

integer (int64)

+
+

creatorFullName
+optional

+
+

string

+
+

description
+optional

+
+

string

+
+

duplicated
+optional

+
+

boolean

+
+

empty
+optional

+
+

boolean

+
+

esId
+optional

+
+

string

+
+

generated
+optional

+
+

boolean

+
+

generatedFromId
+optional

+
+

string

+
+

heatParameters
+optional

+
+

heatParamsUpdateDate
+optional

+
+

integer (int64)

+
+

isFromCsar
+optional

+
+

boolean

+
+

lastUpdateDate
+optional

+
+

integer (int64)

+
+

listHeatParameters
+optional

+
+

mandatory
+optional

+
+

boolean

+
+

ownerId
+optional

+
+

string

+
+

payloadData
+optional

+
+

< string (byte) > array

+
+

payloadUpdateDate
+optional

+
+

integer (int64)

+
+

requiredArtifacts
+optional

+
+

< string > array

+
+

serviceApi
+optional

+
+

boolean

+
+

timeout
+optional

+
+

integer (int32)

+
+

uniqueId
+optional

+
+

string

+
+

updaterFullName
+optional

+
+

string

+
+

userIdCreator
+optional

+
+

string

+
+

userIdLastUpdater
+optional

+
+

string

+
+ +
+
+

3.5. AssetMetadata

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

invariantUUID
+optional

+
+

string

+
+

name
+optional

+
+

string

+
+

toscaModelURL
+optional

+
+

string

+
+

uuid
+optional

+
+

string

+
+

version
+optional

+
+

string

+
+ +
+
+

3.6. CapabilityDataDefinition

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

capabilitySources
+optional

+
+

< string > array

+
+

description
+optional

+
+

string

+
+

empty
+optional

+
+

boolean

+
+

leftOccurrences
+optional

+
+

string

+
+

maxOccurrences
+optional

+
+

string

+
+

minOccurrences
+optional

+
+

string

+
+

name
+optional

+
+

string

+
+

ownerId
+optional

+
+

string

+
+

ownerName
+optional

+
+

string

+
+

parentName
+optional

+
+

string

+
+

path
+optional

+
+

< string > array

+
+

source
+optional

+
+

string

+
+

type
+optional

+
+

string

+
+

uniqueId
+optional

+
+

string

+
+

validSourceTypes
+optional

+
+

< string > array

+
+ +
+
+

3.7. CapabilityDefinition

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

capabilitySources
+optional

+
+

< string > array

+
+

description
+optional

+
+

string

+
+

empty
+optional

+
+

boolean

+
+

leftOccurrences
+optional

+
+

string

+
+

maxOccurrences
+optional

+
+

string

+
+

minOccurrences
+optional

+
+

string

+
+

name
+optional

+
+

string

+
+

ownerId
+optional

+
+

string

+
+

ownerName
+optional

+
+

string

+
+

parentName
+optional

+
+

string

+
+

path
+optional

+
+

< string > array

+
+

properties
+optional

+
+

source
+optional

+
+

string

+
+

type
+optional

+
+

string

+
+

uniqueId
+optional

+
+

string

+
+

validSourceTypes
+optional

+
+

< string > array

+
+ +
+
+

3.8. CapabilityRequirementRelationship

+ ++++ + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

capability
+optional

+
+

relation
+optional

+
+

requirement
+optional

+
+ +
+
+

3.9. CategoryDefinition

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

empty
+optional

+
+

boolean

+
+

icons
+optional

+
+

< string > array

+
+

name
+optional

+
+

string

+
+

normalizedName
+optional

+
+

string

+
+

ownerId
+optional

+
+

string

+
+

subcategories
+optional

+
+

< SubCategoryDefinition > array

+
+

uniqueId
+optional

+
+

string

+
+ +
+
+

3.10. ComponentInstance

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

actualComponentUid
+optional

+
+

string

+
+

artifacts
+optional

+
+

< string, ArtifactDefinition > map

+
+

attributeValueCounter
+optional

+
+

integer (int32)

+
+

capabilities
+optional

+
+

< string, < CapabilityDefinition > array > map

+
+

componentName
+optional

+
+

string

+
+

componentUid
+optional

+
+

string

+
+

componentVersion
+optional

+
+

string

+
+

creationTime
+optional

+
+

integer (int64)

+
+

customizationUUID
+optional

+
+

string

+
+

deploymentArtifacts
+optional

+
+

< string, ArtifactDefinition > map

+
+

description
+optional

+
+

string

+
+

empty
+optional

+
+

boolean

+
+

groupInstances
+optional

+
+

< GroupInstance > array

+
+

icon
+optional

+
+

string

+
+

inputValueCounter
+optional

+
+

integer (int32)

+
+

invariantName
+optional

+
+

string

+
+

isProxy
+optional

+
+

boolean

+
+

modificationTime
+optional

+
+

integer (int64)

+
+

name
+optional

+
+

string

+
+

normalizedName
+optional

+
+

string

+
+

originType
+optional

+
+

enum (PRODUCT, SERVICE, VF, VFC, CP, VL, Configuration, VFCMT, CVFC, PNF, CR, ServiceProxy)

+
+

ownerId
+optional

+
+

string

+
+

posX
+optional

+
+

string

+
+

posY
+optional

+
+

string

+
+

propertyValueCounter
+optional

+
+

integer (int32)

+
+

requirements
+optional

+
+

< string, < RequirementDefinition > array > map

+
+

sourceModelInvariant
+optional

+
+

string

+
+

sourceModelName
+optional

+
+

string

+
+

sourceModelUid
+optional

+
+

string

+
+

sourceModelUuid
+optional

+
+

string

+
+

toscaComponentName
+optional

+
+

string

+
+

uniqueId
+optional

+
+

string

+
+ +
+
+

3.11. ComponentInstanceInput

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

componentInstanceId
+optional

+
+

string

+
+

componentInstanceName
+optional

+
+

string

+
+

constraints
+optional

+
+

< PropertyConstraint > array

+
+

defaultValue
+optional

+
+

string

+
+

definition
+optional

+
+

boolean

+
+

description
+optional

+
+

string

+
+

empty
+optional

+
+

boolean

+
+

getInputProperty
+optional

+
+

boolean

+
+

getInputValues
+optional

+
+

hidden
+optional

+
+

boolean

+
+

immutable
+optional

+
+

boolean

+
+

inputId
+optional

+
+

string

+
+

inputPath
+optional

+
+

string

+
+

inputs
+optional

+
+

instanceUniqueId
+optional

+
+

string

+
+

label
+optional

+
+

string

+
+

name
+optional

+
+

string

+
+

ownerId
+optional

+
+

string

+
+

parentUniqueId
+optional

+
+

string

+
+

password
+optional

+
+

boolean

+
+

path
+optional

+
+

< string > array

+
+

properties
+optional

+
+

propertyId
+optional

+
+

string

+
+

required
+optional

+
+

boolean

+
+

rules
+optional

+
+

< PropertyRule > array

+
+

schema
+optional

+
+

schemaType
+optional

+
+

string

+
+

status
+optional

+
+

string

+
+

type
+optional

+
+

string

+
+

uniqueId
+optional

+
+

string

+
+

value
+optional

+
+

string

+
+

valueUniqueUid
+optional

+
+

string

+
+ +
+
+

3.12. ComponentInstanceProperty

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

componentInstanceId
+optional

+
+

string

+
+

componentInstanceName
+optional

+
+

string

+
+

constraints
+optional

+
+

< PropertyConstraint > array

+
+

defaultValue
+optional

+
+

string

+
+

definition
+optional

+
+

boolean

+
+

description
+optional

+
+

string

+
+

empty
+optional

+
+

boolean

+
+

getInputProperty
+optional

+
+

boolean

+
+

getInputValues
+optional

+
+

hidden
+optional

+
+

boolean

+
+

immutable
+optional

+
+

boolean

+
+

inputId
+optional

+
+

string

+
+

inputPath
+optional

+
+

string

+
+

instanceUniqueId
+optional

+
+

string

+
+

label
+optional

+
+

string

+
+

name
+optional

+
+

string

+
+

ownerId
+optional

+
+

string

+
+

parentUniqueId
+optional

+
+

string

+
+

password
+optional

+
+

boolean

+
+

path
+optional

+
+

< string > array

+
+

propertyId
+optional

+
+

string

+
+

required
+optional

+
+

boolean

+
+

rules
+optional

+
+

< PropertyRule > array

+
+

schema
+optional

+
+

schemaType
+optional

+
+

string

+
+

status
+optional

+
+

string

+
+

type
+optional

+
+

string

+
+

uniqueId
+optional

+
+

string

+
+

value
+optional

+
+

string

+
+

valueUniqueUid
+optional

+
+

string

+
+ +
+
+

3.13. GetInputValueDataDefinition

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

empty
+optional

+
+

boolean

+
+

getInputIndex
+optional

+
+

indexValue
+optional

+
+

integer (int32)

+
+

inputId
+optional

+
+

string

+
+

inputName
+optional

+
+

string

+
+

list
+optional

+
+

boolean

+
+

ownerId
+optional

+
+

string

+
+

propName
+optional

+
+

string

+
+ +
+
+

3.14. GroupDefinition

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

artifacts
+optional

+
+

< string > array

+
+

artifactsUuid
+optional

+
+

< string > array

+
+

description
+optional

+
+

string

+
+

empty
+optional

+
+

boolean

+
+

groupUUID
+optional

+
+

string

+
+

invariantUUID
+optional

+
+

string

+
+

members
+optional

+
+

< string, string > map

+
+

name
+optional

+
+

string

+
+

ownerId
+optional

+
+

string

+
+

properties
+optional

+
+

propertyValueCounter
+optional

+
+

integer (int32)

+
+

type
+optional

+
+

string

+
+

typeUid
+optional

+
+

string

+
+

uniqueId
+optional

+
+

string

+
+

version
+optional

+
+

string

+
+ +
+
+

3.15. GroupInstance

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

artifacts
+optional

+
+

< string > array

+
+

artifactsUuid
+optional

+
+

< string > array

+
+

creationTime
+optional

+
+

integer (int64)

+
+

customizationUUID
+optional

+
+

string

+
+

description
+optional

+
+

string

+
+

empty
+optional

+
+

boolean

+
+

groupInstanceArtifacts
+optional

+
+

< string > array

+
+

groupInstanceArtifactsUuid
+optional

+
+

< string > array

+
+

groupName
+optional

+
+

string

+
+

groupUUID
+optional

+
+

string

+
+

groupUid
+optional

+
+

string

+
+

invariantUUID
+optional

+
+

string

+
+

modificationTime
+optional

+
+

integer (int64)

+
+

name
+optional

+
+

string

+
+

normalizedName
+optional

+
+

string

+
+

ownerId
+optional

+
+

string

+
+

posX
+optional

+
+

string

+
+

posY
+optional

+
+

string

+
+

properties
+optional

+
+

propertyValueCounter
+optional

+
+

integer (int32)

+
+

type
+optional

+
+

string

+
+

uniqueId
+optional

+
+

string

+
+

version
+optional

+
+

string

+
+ +
+
+

3.16. GroupingDefinition

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

empty
+optional

+
+

boolean

+
+

name
+optional

+
+

string

+
+

normalizedName
+optional

+
+

string

+
+

ownerId
+optional

+
+

string

+
+

uniqueId
+optional

+
+

string

+
+ +
+
+

3.17. HeatParameterDataDefinition

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

currentValue
+optional

+
+

string

+
+

defaultValue
+optional

+
+

string

+
+

description
+optional

+
+

string

+
+

empty
+optional

+
+

boolean

+
+

name
+optional

+
+

string

+
+

ownerId
+optional

+
+

string

+
+

type
+optional

+
+

string

+
+

uniqueId
+optional

+
+

string

+
+ +
+
+

3.18. HeatParameterDefinition

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

currentValue
+optional

+
+

string

+
+

defaultValue
+optional

+
+

string

+
+

description
+optional

+
+

string

+
+

empty
+optional

+
+

boolean

+
+

name
+optional

+
+

string

+
+

ownerId
+optional

+
+

string

+
+

type
+optional

+
+

string

+
+

uniqueId
+optional

+
+

string

+
+ +
+
+

3.19. InputDefinition

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

constraints
+optional

+
+

< PropertyConstraint > array

+
+

defaultValue
+optional

+
+

string

+
+

definition
+optional

+
+

boolean

+
+

description
+optional

+
+

string

+
+

empty
+optional

+
+

boolean

+
+

getInputProperty
+optional

+
+

boolean

+
+

getInputValues
+optional

+
+

hidden
+optional

+
+

boolean

+
+

immutable
+optional

+
+

boolean

+
+

inputId
+optional

+
+

string

+
+

inputPath
+optional

+
+

string

+
+

inputs
+optional

+
+

instanceUniqueId
+optional

+
+

string

+
+

label
+optional

+
+

string

+
+

name
+optional

+
+

string

+
+

ownerId
+optional

+
+

string

+
+

parentUniqueId
+optional

+
+

string

+
+

password
+optional

+
+

boolean

+
+

properties
+optional

+
+

propertyId
+optional

+
+

string

+
+

required
+optional

+
+

boolean

+
+

schema
+optional

+
+

schemaType
+optional

+
+

string

+
+

status
+optional

+
+

string

+
+

type
+optional

+
+

string

+
+

uniqueId
+optional

+
+

string

+
+

value
+optional

+
+

string

+
+ +
+
+

3.20. InterfaceDefinition

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

creationDate
+optional

+
+

integer (int64)

+
+

definition
+optional

+
+

boolean

+
+

description
+optional

+
+

string

+
+

empty
+optional

+
+

boolean

+
+

lastUpdateDate
+optional

+
+

integer (int64)

+
+

operations
+optional

+
+

< string, OperationDataDefinition > map

+
+

ownerId
+optional

+
+

string

+
+

toscaResourceName
+optional

+
+

string

+
+

type
+optional

+
+

string

+
+

uniqueId
+optional

+
+

string

+
+ +
+
+

3.21. InterfaceOperationDataDefinition

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

artifactUUID
+optional

+
+

string

+
+

description
+optional

+
+

string

+
+

empty
+optional

+
+

boolean

+
+

inputParams
+optional

+
+

operationType
+optional

+
+

string

+
+

outputParams
+optional

+
+

ownerId
+optional

+
+

string

+
+

toscaResourceName
+optional

+
+

string

+
+

uniqueId
+optional

+
+

string

+
+ +
+
+

3.22. InterfaceOperationParamDataDefinition

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

empty
+optional

+
+

boolean

+
+

ownerId
+optional

+
+

string

+
+

paramId
+optional

+
+

string

+
+

paramName
+optional

+
+

string

+
+ +
+
+

3.23. LifecycleChangeInfoWithAction

+ ++++ + + + + + + + + + + + + + + + + +
NameSchema
+

action
+optional

+
+

enum (CREATE_FROM_CSAR, UPDATE_FROM_EXTERNAL_API, UPGRADE_MIGRATION)

+
+

userRemarks
+optional

+
+

string

+
+ +
+
+

3.24. ListDataDefinition

+ ++++ + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

empty
+optional

+
+

boolean

+
+

listToscaDataDefinition
+optional

+
+

< ToscaDataDefinition > array

+
+

ownerId
+optional

+
+

string

+
+ +
+
+

3.25. ListDataDefinitionInterfaceOperationParamDataDefinition

+ ++++ + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

empty
+optional

+
+

boolean

+
+

listToscaDataDefinition
+optional

+
+

ownerId
+optional

+
+

string

+
+ +
+
+

3.26. ListDataDefinitionOperationInputDefinition

+ ++++ + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

empty
+optional

+
+

boolean

+
+

listToscaDataDefinition
+optional

+
+

ownerId
+optional

+
+

string

+
+ +
+
+

3.27. OperationDataDefinition

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

creationDate
+optional

+
+

integer (int64)

+
+

description
+optional

+
+

string

+
+

empty
+optional

+
+

boolean

+
+

implementation
+optional

+
+

inputs
+optional

+
+

lastUpdateDate
+optional

+
+

integer (int64)

+
+

name
+optional

+
+

string

+
+

ownerId
+optional

+
+

string

+
+

uniqueId
+optional

+
+

string

+
+ +
+
+

3.28. OperationInputDefinition

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

defaultValue
+optional

+
+

string

+
+

definition
+optional

+
+

boolean

+
+

description
+optional

+
+

string

+
+

empty
+optional

+
+

boolean

+
+

getInputProperty
+optional

+
+

boolean

+
+

getInputValues
+optional

+
+

hidden
+optional

+
+

boolean

+
+

immutable
+optional

+
+

boolean

+
+

inputId
+optional

+
+

string

+
+

inputPath
+optional

+
+

string

+
+

instanceUniqueId
+optional

+
+

string

+
+

label
+optional

+
+

string

+
+

name
+optional

+
+

string

+
+

ownerId
+optional

+
+

string

+
+

parentUniqueId
+optional

+
+

string

+
+

password
+optional

+
+

boolean

+
+

propertyId
+optional

+
+

string

+
+

required
+optional

+
+

boolean

+
+

schema
+optional

+
+

schemaType
+optional

+
+

string

+
+

status
+optional

+
+

string

+
+

type
+optional

+
+

string

+
+

uniqueId
+optional

+
+

string

+
+

value
+optional

+
+

string

+
+ +
+
+

3.29. PolicyDefinition

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

componentName
+optional

+
+

string

+
+

derivedFrom
+optional

+
+

string

+
+

description
+optional

+
+

string

+
+

empty
+optional

+
+

boolean

+
+

invariantName
+optional

+
+

string

+
+

invariantUUID
+optional

+
+

string

+
+

isFromCsar
+optional

+
+

boolean

+
+

name
+optional

+
+

string

+
+

normalizedName
+optional

+
+

string

+
+

ownerId
+optional

+
+

string

+
+

policyTypeName
+optional

+
+

string

+
+

policyTypeUid
+optional

+
+

string

+
+

policyUUID
+optional

+
+

string

+
+

properties
+optional

+
+

targets
+optional

+
+

< string, < string > array > map

+
+

uniqueId
+optional

+
+

string

+
+

version
+optional

+
+

string

+
+ +
+
+

3.30. PropertyConstraint

+
+

Type : object

+
+
+
+

3.31. PropertyDataDefinition

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

defaultValue
+optional

+
+

string

+
+

definition
+optional

+
+

boolean

+
+

description
+optional

+
+

string

+
+

empty
+optional

+
+

boolean

+
+

getInputProperty
+optional

+
+

boolean

+
+

getInputValues
+optional

+
+

hidden
+optional

+
+

boolean

+
+

immutable
+optional

+
+

boolean

+
+

inputId
+optional

+
+

string

+
+

inputPath
+optional

+
+

string

+
+

instanceUniqueId
+optional

+
+

string

+
+

label
+optional

+
+

string

+
+

name
+optional

+
+

string

+
+

ownerId
+optional

+
+

string

+
+

parentUniqueId
+optional

+
+

string

+
+

password
+optional

+
+

boolean

+
+

propertyId
+optional

+
+

string

+
+

required
+optional

+
+

boolean

+
+

schema
+optional

+
+

schemaType
+optional

+
+

string

+
+

status
+optional

+
+

string

+
+

type
+optional

+
+

string

+
+

uniqueId
+optional

+
+

string

+
+

value
+optional

+
+

string

+
+ +
+
+

3.32. PropertyDefinition

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

constraints
+optional

+
+

< PropertyConstraint > array

+
+

defaultValue
+optional

+
+

string

+
+

definition
+optional

+
+

boolean

+
+

description
+optional

+
+

string

+
+

empty
+optional

+
+

boolean

+
+

getInputProperty
+optional

+
+

boolean

+
+

getInputValues
+optional

+
+

hidden
+optional

+
+

boolean

+
+

immutable
+optional

+
+

boolean

+
+

inputId
+optional

+
+

string

+
+

inputPath
+optional

+
+

string

+
+

instanceUniqueId
+optional

+
+

string

+
+

label
+optional

+
+

string

+
+

name
+optional

+
+

string

+
+

ownerId
+optional

+
+

string

+
+

parentUniqueId
+optional

+
+

string

+
+

password
+optional

+
+

boolean

+
+

propertyId
+optional

+
+

string

+
+

required
+optional

+
+

boolean

+
+

schema
+optional

+
+

schemaType
+optional

+
+

string

+
+

status
+optional

+
+

string

+
+

type
+optional

+
+

string

+
+

uniqueId
+optional

+
+

string

+
+

value
+optional

+
+

string

+
+ +
+
+

3.33. PropertyRule

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

empty
+optional

+
+

boolean

+
+

ownerId
+optional

+
+

string

+
+

rule
+optional

+
+

< string > array

+
+

value
+optional

+
+

string

+
+ +
+
+

3.34. RegistrationRequest

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

apiPublicKey
+optional

+
+

string

+
+

distEnvEndPoints
+optional

+
+

< string > array

+
+

distrEnvName
+optional

+
+

string

+
+

isConsumerToSdcDistrStatusTopic
+optional

+
+

boolean

+
+ +
+
+

3.35. RelationshipImpl

+ ++++ + + + + + + + + + + + + +
NameSchema
+

type
+optional

+
+

string

+
+ +
+
+

3.36. RelationshipInfo

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

capability
+optional

+
+

string

+
+

capabilityOwnerId
+optional

+
+

string

+
+

capabilityUid
+optional

+
+

string

+
+

id
+optional

+
+

string

+
+

relationship
+optional

+
+

requirement
+optional

+
+

string

+
+

requirementOwnerId
+optional

+
+

string

+
+

requirementUid
+optional

+
+

string

+
+ +
+
+

3.37. RequirementCapabilityRelDef

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

fromNode
+optional

+
+

string

+
+

relationships
+optional

+
+

toNode
+optional

+
+

string

+
+

uid
+optional

+
+

string

+
+ +
+
+

3.38. RequirementDataDefinition

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

capability
+optional

+
+

string

+
+

empty
+optional

+
+

boolean

+
+

leftOccurrences
+optional

+
+

string

+
+

maxOccurrences
+optional

+
+

string

+
+

minOccurrences
+optional

+
+

string

+
+

name
+optional

+
+

string

+
+

node
+optional

+
+

string

+
+

ownerId
+optional

+
+

string

+
+

ownerName
+optional

+
+

string

+
+

parentName
+optional

+
+

string

+
+

path
+optional

+
+

< string > array

+
+

relationship
+optional

+
+

string

+
+

source
+optional

+
+

string

+
+

uniqueId
+optional

+
+

string

+
+ +
+
+

3.39. RequirementDefinition

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

capability
+optional

+
+

string

+
+

empty
+optional

+
+

boolean

+
+

leftOccurrences
+optional

+
+

string

+
+

maxOccurrences
+optional

+
+

string

+
+

minOccurrences
+optional

+
+

string

+
+

name
+optional

+
+

string

+
+

node
+optional

+
+

string

+
+

ownerId
+optional

+
+

string

+
+

ownerName
+optional

+
+

string

+
+

parentName
+optional

+
+

string

+
+

path
+optional

+
+

< string > array

+
+

relationship
+optional

+
+

string

+
+

source
+optional

+
+

string

+
+

uniqueId
+optional

+
+

string

+
+ +
+
+

3.40. Resource

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

abstract
+optional

+
+

boolean

+
+

additionalInformation
+optional

+
+

allArtifacts
+optional

+
+

< string, ArtifactDefinition > map

+
+

allVersions
+optional

+
+

< string, string > map

+
+

artifacts
+optional

+
+

< string, ArtifactDefinition > map

+
+

attributes
+optional

+
+

< PropertyDefinition > array

+
+

capabilities
+optional

+
+

< string, < CapabilityDefinition > array > map

+
+

categories
+optional

+
+

< CategoryDefinition > array

+
+

componentInstances
+optional

+
+

< ComponentInstance > array

+
+

componentInstancesAttributes
+optional

+
+

< string, < ComponentInstanceProperty > array > map

+
+

componentInstancesInputs
+optional

+
+

< string, < ComponentInstanceInput > array > map

+
+

componentInstancesProperties
+optional

+
+

< string, < ComponentInstanceProperty > array > map

+
+

componentInstancesRelations
+optional

+
+

componentType
+optional

+
+

enum (RESOURCE, SERVICE, RESOURCE_INSTANCE, PRODUCT, SERVICE_INSTANCE)

+
+

conformanceLevel
+optional

+
+

string

+
+

contactId
+optional

+
+

string

+
+

cost
+optional

+
+

string

+
+

creationDate
+optional

+
+

integer (int64)

+
+

creatorFullName
+optional

+
+

string

+
+

creatorUserId
+optional

+
+

string

+
+

csarUUID
+optional

+
+

string

+
+

csarVersion
+optional

+
+

string

+
+

defaultCapabilities
+optional

+
+

< string > array

+
+

deploymentArtifacts
+optional

+
+

< string, ArtifactDefinition > map

+
+

derivedFrom
+optional

+
+

< string > array

+
+

derivedFromGenericType
+optional

+
+

string

+
+

derivedFromGenericVersion
+optional

+
+

string

+
+

derivedList
+optional

+
+

< string > array

+
+

description
+optional

+
+

string

+
+

groups
+optional

+
+

< GroupDefinition > array

+
+

highestVersion
+optional

+
+

boolean

+
+

icon
+optional

+
+

string

+
+

importedToscaChecksum
+optional

+
+

string

+
+

inputs
+optional

+
+

< InputDefinition > array

+
+

interfaceOperations
+optional

+
+

interfaces
+optional

+
+

< string, InterfaceDefinition > map

+
+

invariantUUID
+optional

+
+

string

+
+

isDeleted
+optional

+
+

boolean

+
+

lastUpdateDate
+optional

+
+

integer (int64)

+
+

lastUpdaterFullName
+optional

+
+

string

+
+

lastUpdaterUserId
+optional

+
+

string

+
+

licenseType
+optional

+
+

string

+
+

lifecycleState
+optional

+
+

enum (READY_FOR_CERTIFICATION, CERTIFICATION_IN_PROGRESS, CERTIFIED, NOT_CERTIFIED_CHECKIN, NOT_CERTIFIED_CHECKOUT)

+
+

name
+optional

+
+

string

+
+

normalizedName
+optional

+
+

string

+
+

policies
+optional

+
+

< string, PolicyDefinition > map

+
+

projectCode
+optional

+
+

string

+
+

properties
+optional

+
+

< PropertyDefinition > array

+
+

requirements
+optional

+
+

< string, < RequirementDefinition > array > map

+
+

resourceType
+optional

+
+

enum (VFC, VF, CR, CP, PNF, CVFC, VL, VFCMT, Configuration, ServiceProxy, ABSTRACT)

+
+

resourceVendorModelNumber
+optional

+
+

string

+
+

systemName
+optional

+
+

string

+
+

tags
+optional

+
+

< string > array

+
+

topologyTemplate
+optional

+
+

boolean

+
+

toscaArtifacts
+optional

+
+

< string, ArtifactDefinition > map

+
+

toscaResourceName
+optional

+
+

string

+
+

toscaType
+optional

+
+

string

+
+

uniqueId
+optional

+
+

string

+
+

uuid
+optional

+
+

string

+
+

vendorName
+optional

+
+

string

+
+

vendorRelease
+optional

+
+

string

+
+

version
+optional

+
+

string

+
+ +
+
+

3.41. SchemaDefinition

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

constraints
+optional

+
+

< string > array

+
+

derivedFrom
+optional

+
+

string

+
+

empty
+optional

+
+

boolean

+
+

ownerId
+optional

+
+

string

+
+

properties
+optional

+
+

< string, PropertyDataDefinition > map

+
+

property
+optional

+
+ +
+
+

3.42. ServerListResponse

+ ++++ + + + + + + + + + + + + +
NameSchema
+

uebServerList
+optional

+
+

< string > array

+
+ +
+
+

3.43. SubCategoryDefinition

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

empty
+optional

+
+

boolean

+
+

groupings
+optional

+
+

< GroupingDefinition > array

+
+

icons
+optional

+
+

< string > array

+
+

name
+optional

+
+

string

+
+

normalizedName
+optional

+
+

string

+
+

ownerId
+optional

+
+

string

+
+

uniqueId
+optional

+
+

string

+
+ +
+
+

3.44. TopicRegistrationResponse

+ ++++ + + + + + + + + + + + + + + + + +
NameSchema
+

distrNotificationTopicName
+optional

+
+

string

+
+

distrStatusTopicName
+optional

+
+

string

+
+ +
+
+

3.45. TopicUnregistrationResponse

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + +
NameSchema
+

distrNotificationTopicName
+optional

+
+

string

+
+

distrStatusTopicName
+optional

+
+

string

+
+

notificationUnregisterResult
+optional

+
+

enum (OK, CONNNECTION_ERROR, NOT_FOUND, TOPIC_ALREADY_EXIST, OBJECT_NOT_FOUND, INTERNAL_SERVER_ERROR, AUTHENTICATION_ERROR, UNKNOWN_HOST_ERROR)

+
+

statusUnregisterResult
+optional

+
+

enum (OK, CONNNECTION_ERROR, NOT_FOUND, TOPIC_ALREADY_EXIST, OBJECT_NOT_FOUND, INTERNAL_SERVER_ERROR, AUTHENTICATION_ERROR, UNKNOWN_HOST_ERROR)

+
+ +
+
+

3.46. ToscaDataDefinition

+ ++++ + + + + + + + + + + + + + + + + +
NameSchema
+

empty
+optional

+
+

boolean

+
+

ownerId
+optional

+
+

string

+
+ +
+
+
+
+ + + \ No newline at end of file -- cgit 1.2.3-korg