2. Paths
2.1. Artifact types list
GET /v1/artifactTypes
2.1.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept |
The username and password |
string |
Header |
Authorization |
The username and password |
string |
Header |
X-ECOMP-InstanceID |
X-ECOMP-InstanceID header |
string |
Header |
X-ECOMP-RequestID |
X-ECOMP-RequestID header |
string |
2.1.3. Responses
| HTTP Code | Description | Schema |
|---|---|---|
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.2. uploads of artifact to VF operation workflow
POST /v1/catalog/resources/{uuid}/interfaces/{operationUUID}/artifacts/{artifactUUID}
2.2.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept |
Determines the format of the body of the response |
string |
Header |
Authorization |
The username and password |
string |
Header |
Content-MD5 |
The value for this header must be the MD5 checksum over the whole json body |
string |
Header |
Content-Type |
Determines the format of the body of the request |
string |
Header |
USER_ID |
The user ID of the DCAE Designer. This user must also have Designer role in SDC |
string |
Header |
X-ECOMP-InstanceID |
X-ECOMP-InstanceID header |
string |
Header |
X-ECOMP-RequestID |
X-ECOMP-RequestID header |
string |
Path |
artifactUUID |
The uuid of the artifact |
string |
Path |
operationUUID |
The uuid of the operation |
string |
Path |
uuid |
The uuid of the asset as published in the metadata |
string |
Body |
body |
json describe the artifact |
2.2.3. Responses
| HTTP Code | Description | Schema |
|---|---|---|
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.3. Download service artifact
GET /v1/catalog/services/{serviceName}/{serviceVersion}/artifacts/{artifactName}
2.3.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept |
Determines the format of the body of the response |
string |
Header |
Authorization |
The username and password |
string |
Header |
X-ECOMP-InstanceID |
X-ECOMP-InstanceID header |
string |
Header |
X-ECOMP-RequestID |
X-ECOMP-RequestID header |
string |
Path |
artifactName |
string |
|
Path |
serviceName |
string |
|
Path |
serviceVersion |
string |
2.3.3. Responses
| HTTP Code | Description | Schema |
|---|---|---|
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. Download resource instance artifact
GET /v1/catalog/services/{serviceName}/{serviceVersion}/resourceInstances/{resourceInstanceName}/artifacts/{artifactName}
2.4.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept |
Determines the format of the body of the response |
string |
Header |
Authorization |
The username and password |
string |
Header |
X-ECOMP-InstanceID |
X-ECOMP-InstanceID header |
string |
Header |
X-ECOMP-RequestID |
X-ECOMP-RequestID header |
string |
Path |
artifactName |
string |
|
Path |
resourceInstanceName |
string |
|
Path |
serviceName |
string |
|
Path |
serviceVersion |
string |
2.4.3. Responses
| HTTP Code | Description | Schema |
|---|---|---|
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. Download resource artifact
GET /v1/catalog/services/{serviceName}/{serviceVersion}/resources/{resourceName}/{resourceVersion}/artifacts/{artifactName}
2.5.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept |
Determines the format of the body of the response |
string |
Header |
Authorization |
The username and password |
string |
Header |
X-ECOMP-InstanceID |
X-ECOMP-InstanceID header |
string |
Header |
X-ECOMP-RequestID |
X-ECOMP-RequestID header |
string |
Path |
artifactName |
string |
|
Path |
resourceName |
string |
|
Path |
resourceVersion |
string |
|
Path |
serviceName |
string |
|
Path |
serviceVersion |
string |
2.5.3. Responses
| HTTP Code | Description | Schema |
|---|---|---|
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.6. activate a service
POST /v1/catalog/services/{serviceUUID}/distribution/{opEnvId}/activate
2.6.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept |
Determines the format of the body of the response |
string |
Header |
Authorization |
The username and password |
string |
Header |
Content-Type |
Determines the format of the body of the request |
string |
Header |
USER_ID |
The user id |
string |
Header |
X-ECOMP-InstanceID |
X-ECOMP-InstanceID header |
string |
Header |
X-ECOMP-RequestID |
X-ECOMP-RequestID header |
string |
Path |
opEnvId |
The operational environment on which to activate the service on |
string |
Path |
serviceUUID |
The serviceUUid to activate |
string |
Body |
body |
string |
2.6.3. Responses
| HTTP Code | Description | Schema |
|---|---|---|
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.7. creates a resource
POST /v1/catalog/{assetType}
2.7.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept |
Determines the format of the body of the response |
string |
Header |
Authorization |
The username and password |
string |
Header |
Content-Type |
Determines the format of the body of the request |
string |
Header |
USER_ID |
The user id |
string |
Header |
X-ECOMP-InstanceID |
X-ECOMP-InstanceID header |
string |
Header |
X-ECOMP-RequestID |
X-ECOMP-RequestID header |
string |
Path |
assetType |
The requested asset type |
enum (resources, services) |
Body |
body |
json describe the created resource |
2.7.3. Responses
| HTTP Code | Description | Schema |
|---|---|---|
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.8. Fetch list of assets
GET /v1/catalog/{assetType}
2.8.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept |
Determines the format of the body of the response |
string |
Header |
Authorization |
The username and password |
string |
Header |
X-ECOMP-InstanceID |
X-ECOMP-InstanceID header |
string |
Header |
X-ECOMP-RequestID |
X-ECOMP-RequestID header |
string |
Path |
assetType |
The requested asset type |
enum (resources, services) |
Query |
category |
The filter key (resourceType only for resources) |
string |
Query |
distributionStatus |
The filter key (resourceType only for resources) |
string |
Query |
resourceType |
The filter key (resourceType only for resources) |
string |
Query |
subCategory |
The filter key (resourceType only for resources) |
string |
2.8.3. Responses
| HTTP Code | Description | Schema |
|---|---|---|
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.9. uploads of artifact to a resource or service
POST /v1/catalog/{assetType}/{uuid}/artifacts
2.9.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept |
Determines the format of the body of the response |
string |
Header |
Authorization |
The username and password |
string |
Header |
Content-MD5 |
The value for this header must be the MD5 checksum over the whole json body |
string |
Header |
Content-Type |
Determines the format of the body of the request |
string |
Header |
USER_ID |
The user ID of the DCAE Designer. This user must also have Designer role in SDC |
string |
Header |
X-ECOMP-InstanceID |
X-ECOMP-InstanceID header |
string |
Header |
X-ECOMP-RequestID |
X-ECOMP-RequestID header |
string |
Path |
assetType |
The requested asset type |
enum (resources, services) |
Path |
uuid |
The uuid of the asset as published in the metadata |
string |
Body |
body |
json describe the artifact |
2.9.3. Responses
| HTTP Code | Description | Schema |
|---|---|---|
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.10. updates an artifact on a resource or service
POST /v1/catalog/{assetType}/{uuid}/artifacts/{artifactUUID}
2.10.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept |
Determines the format of the body of the response |
string |
Header |
Authorization |
The username and password |
string |
Header |
Content-MD5 |
The value for this header must be the MD5 checksum over the whole json body |
string |
Header |
Content-Type |
Determines the format of the body of the request |
string |
Header |
USER_ID |
The user ID of the DCAE Designer. This user must also have Designer role in SDC |
string |
Header |
X-ECOMP-InstanceID |
X-ECOMP-InstanceID header |
string |
Header |
X-ECOMP-RequestID |
X-ECOMP-RequestID header |
string |
Path |
artifactUUID |
The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation |
string |
Path |
assetType |
The requested asset type |
enum (resources, services) |
Path |
uuid |
The uuid of the asset as published in the metadata |
string |
Body |
body |
json describe the artifact |
2.10.3. Responses
| HTTP Code | Description | Schema |
|---|---|---|
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.11. Download component artifact
GET /v1/catalog/{assetType}/{uuid}/artifacts/{artifactUUID}
2.11.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept |
Determines the format of the body of the response |
string |
Header |
Authorization |
The username and password |
string |
Header |
USER_ID |
The user ID of the DCAE Designer. This user must also have Designer role in SDC |
string |
Header |
X-ECOMP-InstanceID |
X-ECOMP-InstanceID header |
string |
Header |
X-ECOMP-RequestID |
X-ECOMP-RequestID header |
string |
Path |
artifactUUID |
The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation |
string |
Path |
assetType |
The requested asset type |
enum (resources, services) |
Path |
uuid |
The uuid of the asset as published in the metadata |
string |
2.11.3. Responses
| HTTP Code | Description | Schema |
|---|---|---|
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.12. deletes an artifact of a resource or service
DELETE /v1/catalog/{assetType}/{uuid}/artifacts/{artifactUUID}
2.12.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept |
Determines the format of the body of the response |
string |
Header |
Authorization |
The username and password |
string |
Header |
USER_ID |
The user ID of the DCAE Designer. This user must also have Designer role in SDC |
string |
Header |
X-ECOMP-InstanceID |
X-ECOMP-InstanceID header |
string |
Header |
X-ECOMP-RequestID |
X-ECOMP-RequestID header |
string |
Path |
artifactUUID |
The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation |
string |
Path |
assetType |
The requested asset type |
enum (resources, services) |
Path |
uuid |
The uuid of the asset as published in the metadata |
string |
2.12.3. Responses
| HTTP Code | Description | Schema |
|---|---|---|
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.13. Change Resource lifecycle State
POST /v1/catalog/{assetType}/{uuid}/lifecycleState/{lifecycleOperation}
2.13.1. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept |
Determines the format of the body of the response |
string |
Header |
Authorization |
The username and password |
string |
Header |
Content-Type |
Determines the format of the body of the request |
string |
Header |
USER_ID |
The user id |
string |
Header |
X-ECOMP-InstanceID |
X-ECOMP-InstanceID header |
string |
Header |
X-ECOMP-RequestID |
X-ECOMP-RequestID header |
string |
Path |
assetType |
validValues: resources / services |
enum (resources, services) |
Path |
lifecycleOperation |
enum (checkout, checkin) |
|
Path |
uuid |
id of component to be changed |
string |
Body |
body |
userRemarks - Short description (free text) about the asset version being changed |
2.13.2. Responses
| HTTP Code | Description | Schema |
|---|---|---|
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.14. Detailed metadata of asset by uuid
GET /v1/catalog/{assetType}/{uuid}/metadata
2.14.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept |
Determines the format of the body of the response |
string |
Header |
Authorization |
The username and password |
string |
Header |
X-ECOMP-InstanceID |
X-ECOMP-InstanceID header |
string |
Header |
X-ECOMP-RequestID |
X-ECOMP-RequestID header |
string |
Path |
assetType |
The requested asset type |
enum (resources, services) |
Path |
uuid |
The requested asset uuid |
string |
2.14.3. Responses
| HTTP Code | Description | Schema |
|---|---|---|
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.15. uploads an artifact to a resource instance
POST /v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceName}/artifacts
2.15.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept |
Determines the format of the body of the response |
string |
Header |
Authorization |
The username and password |
string |
Header |
Content-MD5 |
The value for this header must be the MD5 checksum over the whole json body |
string |
Header |
Content-Type |
Determines the format of the body of the request |
string |
Header |
USER_ID |
The user ID of the DCAE Designer. This user must also have Designer role in SDC |
string |
Header |
X-ECOMP-InstanceID |
X-ECOMP-InstanceID header |
string |
Header |
X-ECOMP-RequestID |
X-ECOMP-RequestID header |
string |
Path |
assetType |
The requested asset type |
enum (resources, services) |
Path |
resourceInstanceName |
The component instance name (as publishedin the response of the detailed query) |
string |
Path |
uuid |
The uuid of the asset as published in the metadata |
string |
Body |
body |
json describe the artifact |
2.15.3. Responses
| HTTP Code | Description | Schema |
|---|---|---|
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.16. updates an artifact on a resource instance
POST /v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceName}/artifacts/{artifactUUID}
2.16.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept |
Determines the format of the body of the response |
string |
Header |
Authorization |
The username and password |
string |
Header |
Content-MD5 |
The value for this header must be the MD5 checksum over the whole json body |
string |
Header |
Content-Type |
Determines the format of the body of the request |
string |
Header |
USER_ID |
The user ID of the DCAE Designer. This user must also have Designer role in SDC |
string |
Header |
X-ECOMP-InstanceID |
X-ECOMP-InstanceID header |
string |
Header |
X-ECOMP-RequestID |
X-ECOMP-RequestID header |
string |
Path |
artifactUUID |
The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation |
string |
Path |
assetType |
The requested asset type |
enum (resources, services) |
Path |
resourceInstanceName |
The component instance name (as publishedin the response of the detailed query) |
string |
Path |
uuid |
The uuid of the asset as published in the metadata |
string |
Body |
body |
json describe the artifact |
2.16.3. Responses
| HTTP Code | Description | Schema |
|---|---|---|
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.17. Download resource instance artifact
GET /v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceName}/artifacts/{artifactUUID}
2.17.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept |
Determines the format of the body of the response |
string |
Header |
Authorization |
The username and password |
string |
Header |
USER_ID |
The user ID of the DCAE Designer. This user must also have Designer role in SDC |
string |
Header |
X-ECOMP-InstanceID |
X-ECOMP-InstanceID header |
string |
Header |
X-ECOMP-RequestID |
X-ECOMP-RequestID header |
string |
Path |
artifactUUID |
The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation |
string |
Path |
assetType |
The requested asset type |
enum (resources, services) |
Path |
resourceInstanceName |
The component instance name (as publishedin the response of the detailed query) |
string |
Path |
uuid |
The uuid of the asset as published in the metadata |
string |
2.17.3. Responses
| HTTP Code | Description | Schema |
|---|---|---|
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.18. deletes an artifact of a resource insatnce
DELETE /v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceName}/artifacts/{artifactUUID}
2.18.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept |
Determines the format of the body of the response |
string |
Header |
Authorization |
The username and password |
string |
Header |
USER_ID |
The user ID of the DCAE Designer. This user must also have Designer role in SDC |
string |
Header |
X-ECOMP-InstanceID |
X-ECOMP-InstanceID header |
string |
Header |
X-ECOMP-RequestID |
X-ECOMP-RequestID header |
string |
Path |
artifactUUID |
The uuid of the artifact as published in the asset detailed metadata or in the response of the upload / update operation |
string |
Path |
assetType |
The requested asset type |
enum (resources, services) |
Path |
resourceInstanceName |
The component instance name (as publishedin the response of the detailed query) |
string |
Path |
uuid |
The uuid of the asset as published in the metadata |
string |
2.18.3. Responses
| HTTP Code | Description | Schema |
|---|---|---|
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.19. Fetch assets CSAR
GET /v1/catalog/{assetType}/{uuid}/toscaModel
2.19.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept |
Determines the format of the body of the response |
string |
Header |
Authorization |
The username and password |
string |
Header |
X-ECOMP-InstanceID |
X-ECOMP-InstanceID header |
string |
Header |
X-ECOMP-RequestID |
X-ECOMP-RequestID header |
string |
Path |
assetType |
The requested asset type |
enum (resources, services) |
Path |
uuid |
The requested asset uuid |
string |
2.19.3. Responses
| HTTP Code | Description | Schema |
|---|---|---|
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.20. UEB Server List
GET /v1/distributionUebCluster
2.20.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept |
Determines the format of the body of the response |
string |
Header |
Authorization |
The username and password |
string |
Header |
X-ECOMP-InstanceID |
X-ECOMP-InstanceID header |
string |
Header |
X-ECOMP-RequestID |
X-ECOMP-RequestID header |
string |
2.20.3. Responses
| HTTP Code | Description | Schema |
|---|---|---|
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.21. Subscription status
POST /v1/registerForDistribution
2.21.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept |
Determines the format of the body of the response |
string |
Header |
Authorization |
The username and password |
string |
Header |
Content-Length |
Length of the request body |
string |
Header |
Content-Type |
Determines the format of the body of the request |
string |
Header |
X-ECOMP-InstanceID |
X-ECOMP-InstanceID header |
string |
Header |
X-ECOMP-RequestID |
X-ECOMP-RequestID header |
string |
Body |
requestJson |
json describe the artifact |
2.21.3. Responses
| HTTP Code | Description | Schema |
|---|---|---|
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.22. Subscription status
POST /v1/unRegisterForDistribution
2.22.2. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept |
Determines the format of the body of the response |
string |
Header |
Authorization |
The username and password |
string |
Header |
Content-Length |
Length of the request body |
string |
Header |
Content-Type |
Determines the format of the body of the request |
string |
Header |
X-ECOMP-InstanceID |
X-ECOMP-InstanceID header |
string |
Header |
X-ECOMP-RequestID |
X-ECOMP-RequestID header |
string |
Body |
requestJson |
json describe the artifact |
2.22.3. Responses
| HTTP Code | Description | Schema |
|---|---|---|
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 |
3. Definitions
3.1. AdditionalInfoParameterInfo
| Name | Schema |
|---|---|
empty |
boolean |
key |
string |
ownerId |
string |
uniqueId |
string |
value |
string |
3.2. AdditionalInformationDefinition
| Name | Schema |
|---|---|
creationTime |
integer (int64) |
empty |
boolean |
lastCreatedCounter |
integer (int32) |
modificationTime |
integer (int64) |
ownerId |
string |
parameters |
< AdditionalInfoParameterInfo > array |
parentUniqueId |
string |
uniqueId |
string |
3.3. ArtifactDataDefinition
| Name | Schema |
|---|---|
apiUrl |
string |
artifactChecksum |
string |
artifactCreator |
string |
artifactDisplayName |
string |
artifactGroupType |
enum (INFORMATIONAL, DEPLOYMENT, LIFE_CYCLE, SERVICE_API, TOSCA, OTHER) |
artifactLabel |
string |
artifactName |
string |
artifactRef |
string |
artifactRepository |
string |
artifactType |
string |
artifactUUID |
string |
artifactVersion |
string |
creationDate |
integer (int64) |
creatorFullName |
string |
description |
string |
duplicated |
boolean |
empty |
boolean |
esId |
string |
generated |
boolean |
generatedFromId |
string |
heatParameters |
< HeatParameterDataDefinition > array |
heatParamsUpdateDate |
integer (int64) |
isFromCsar |
boolean |
lastUpdateDate |
integer (int64) |
mandatory |
boolean |
ownerId |
string |
payloadUpdateDate |
integer (int64) |
requiredArtifacts |
< string > array |
serviceApi |
boolean |
timeout |
integer (int32) |
uniqueId |
string |
updaterFullName |
string |
userIdCreator |
string |
userIdLastUpdater |
string |
3.4. ArtifactDefinition
| Name | Schema |
|---|---|
apiUrl |
string |
artifactChecksum |
string |
artifactCreator |
string |
artifactDisplayName |
string |
artifactGroupType |
enum (INFORMATIONAL, DEPLOYMENT, LIFE_CYCLE, SERVICE_API, TOSCA, OTHER) |
artifactLabel |
string |
artifactName |
string |
artifactRef |
string |
artifactRepository |
string |
artifactType |
string |
artifactUUID |
string |
artifactVersion |
string |
creationDate |
integer (int64) |
creatorFullName |
string |
description |
string |
duplicated |
boolean |
empty |
boolean |
esId |
string |
generated |
boolean |
generatedFromId |
string |
heatParameters |
< HeatParameterDataDefinition > array |
heatParamsUpdateDate |
integer (int64) |
isFromCsar |
boolean |
lastUpdateDate |
integer (int64) |
listHeatParameters |
< HeatParameterDefinition > array |
mandatory |
boolean |
ownerId |
string |
payloadData |
< string (byte) > array |
payloadUpdateDate |
integer (int64) |
requiredArtifacts |
< string > array |
serviceApi |
boolean |
timeout |
integer (int32) |
uniqueId |
string |
updaterFullName |
string |
userIdCreator |
string |
userIdLastUpdater |
string |
3.5. AssetMetadata
| Name | Schema |
|---|---|
invariantUUID |
string |
name |
string |
toscaModelURL |
string |
uuid |
string |
version |
string |
3.6. CapabilityDataDefinition
| Name | Schema |
|---|---|
capabilitySources |
< string > array |
description |
string |
empty |
boolean |
leftOccurrences |
string |
maxOccurrences |
string |
minOccurrences |
string |
name |
string |
ownerId |
string |
ownerName |
string |
parentName |
string |
path |
< string > array |
source |
string |
type |
string |
uniqueId |
string |
validSourceTypes |
< string > array |
3.7. CapabilityDefinition
| Name | Schema |
|---|---|
capabilitySources |
< string > array |
description |
string |
empty |
boolean |
leftOccurrences |
string |
maxOccurrences |
string |
minOccurrences |
string |
name |
string |
ownerId |
string |
ownerName |
string |
parentName |
string |
path |
< string > array |
properties |
< ComponentInstanceProperty > array |
source |
string |
type |
string |
uniqueId |
string |
validSourceTypes |
< string > array |
3.8. CapabilityRequirementRelationship
| Name | Schema |
|---|---|
capability |
|
relation |
|
requirement |
3.9. CategoryDefinition
| Name | Schema |
|---|---|
empty |
boolean |
icons |
< string > array |
name |
string |
normalizedName |
string |
ownerId |
string |
subcategories |
< SubCategoryDefinition > array |
uniqueId |
string |
3.10. ComponentInstance
| Name | Schema |
|---|---|
actualComponentUid |
string |
artifacts |
< string, ArtifactDefinition > map |
attributeValueCounter |
integer (int32) |
capabilities |
< string, < CapabilityDefinition > array > map |
componentName |
string |
componentUid |
string |
componentVersion |
string |
creationTime |
integer (int64) |
customizationUUID |
string |
deploymentArtifacts |
< string, ArtifactDefinition > map |
description |
string |
empty |
boolean |
groupInstances |
< GroupInstance > array |
icon |
string |
inputValueCounter |
integer (int32) |
invariantName |
string |
isProxy |
boolean |
modificationTime |
integer (int64) |
name |
string |
normalizedName |
string |
originType |
enum (PRODUCT, SERVICE, VF, VFC, CP, VL, Configuration, VFCMT, CVFC, PNF, CR, ServiceProxy) |
ownerId |
string |
posX |
string |
posY |
string |
propertyValueCounter |
integer (int32) |
requirements |
< string, < RequirementDefinition > array > map |
sourceModelInvariant |
string |
sourceModelName |
string |
sourceModelUid |
string |
sourceModelUuid |
string |
toscaComponentName |
string |
uniqueId |
string |
3.11. ComponentInstanceInput
| Name | Schema |
|---|---|
componentInstanceId |
string |
componentInstanceName |
string |
constraints |
< PropertyConstraint > array |
defaultValue |
string |
definition |
boolean |
description |
string |
empty |
boolean |
getInputProperty |
boolean |
getInputValues |
< GetInputValueDataDefinition > array |
hidden |
boolean |
immutable |
boolean |
inputId |
string |
inputPath |
string |
inputs |
< ComponentInstanceInput > array |
instanceUniqueId |
string |
label |
string |
name |
string |
ownerId |
string |
parentUniqueId |
string |
password |
boolean |
path |
< string > array |
properties |
< ComponentInstanceProperty > array |
propertyId |
string |
required |
boolean |
rules |
< PropertyRule > array |
schema |
|
schemaType |
string |
status |
string |
type |
string |
uniqueId |
string |
value |
string |
valueUniqueUid |
string |
3.12. ComponentInstanceProperty
| Name | Schema |
|---|---|
componentInstanceId |
string |
componentInstanceName |
string |
constraints |
< PropertyConstraint > array |
defaultValue |
string |
definition |
boolean |
description |
string |
empty |
boolean |
getInputProperty |
boolean |
getInputValues |
< GetInputValueDataDefinition > array |
hidden |
boolean |
immutable |
boolean |
inputId |
string |
inputPath |
string |
instanceUniqueId |
string |
label |
string |
name |
string |
ownerId |
string |
parentUniqueId |
string |
password |
boolean |
path |
< string > array |
propertyId |
string |
required |
boolean |
rules |
< PropertyRule > array |
schema |
|
schemaType |
string |
status |
string |
type |
string |
uniqueId |
string |
value |
string |
valueUniqueUid |
string |
3.13. GetInputValueDataDefinition
| Name | Schema |
|---|---|
empty |
boolean |
getInputIndex |
|
indexValue |
integer (int32) |
inputId |
string |
inputName |
string |
list |
boolean |
ownerId |
string |
propName |
string |
3.14. GroupDefinition
| Name | Schema |
|---|---|
artifacts |
< string > array |
artifactsUuid |
< string > array |
description |
string |
empty |
boolean |
groupUUID |
string |
invariantUUID |
string |
members |
< string, string > map |
name |
string |
ownerId |
string |
properties |
< PropertyDataDefinition > array |
propertyValueCounter |
integer (int32) |
type |
string |
typeUid |
string |
uniqueId |
string |
version |
string |
3.15. GroupInstance
| Name | Schema |
|---|---|
artifacts |
< string > array |
artifactsUuid |
< string > array |
creationTime |
integer (int64) |
customizationUUID |
string |
description |
string |
empty |
boolean |
groupInstanceArtifacts |
< string > array |
groupInstanceArtifactsUuid |
< string > array |
groupName |
string |
groupUUID |
string |
groupUid |
string |
invariantUUID |
string |
modificationTime |
integer (int64) |
name |
string |
normalizedName |
string |
ownerId |
string |
posX |
string |
posY |
string |
properties |
< PropertyDataDefinition > array |
propertyValueCounter |
integer (int32) |
type |
string |
uniqueId |
string |
version |
string |
3.16. GroupingDefinition
| Name | Schema |
|---|---|
empty |
boolean |
name |
string |
normalizedName |
string |
ownerId |
string |
uniqueId |
string |
3.17. HeatParameterDataDefinition
| Name | Schema |
|---|---|
currentValue |
string |
defaultValue |
string |
description |
string |
empty |
boolean |
name |
string |
ownerId |
string |
type |
string |
uniqueId |
string |
3.18. HeatParameterDefinition
| Name | Schema |
|---|---|
currentValue |
string |
defaultValue |
string |
description |
string |
empty |
boolean |
name |
string |
ownerId |
string |
type |
string |
uniqueId |
string |
3.19. InputDefinition
| Name | Schema |
|---|---|
constraints |
< PropertyConstraint > array |
defaultValue |
string |
definition |
boolean |
description |
string |
empty |
boolean |
getInputProperty |
boolean |
getInputValues |
< GetInputValueDataDefinition > array |
hidden |
boolean |
immutable |
boolean |
inputId |
string |
inputPath |
string |
inputs |
< ComponentInstanceInput > array |
instanceUniqueId |
string |
label |
string |
name |
string |
ownerId |
string |
parentUniqueId |
string |
password |
boolean |
properties |
< ComponentInstanceProperty > array |
propertyId |
string |
required |
boolean |
schema |
|
schemaType |
string |
status |
string |
type |
string |
uniqueId |
string |
value |
string |
3.20. InterfaceDefinition
| Name | Schema |
|---|---|
creationDate |
integer (int64) |
definition |
boolean |
description |
string |
empty |
boolean |
lastUpdateDate |
integer (int64) |
operations |
< string, OperationDataDefinition > map |
ownerId |
string |
toscaResourceName |
string |
type |
string |
uniqueId |
string |
3.21. InterfaceOperationDataDefinition
| Name | Schema |
|---|---|
artifactUUID |
string |
description |
string |
empty |
boolean |
inputParams |
|
operationType |
string |
outputParams |
|
ownerId |
string |
toscaResourceName |
string |
uniqueId |
string |
3.22. InterfaceOperationParamDataDefinition
| Name | Schema |
|---|---|
empty |
boolean |
ownerId |
string |
paramId |
string |
paramName |
string |
3.23. LifecycleChangeInfoWithAction
| Name | Schema |
|---|---|
action |
enum (CREATE_FROM_CSAR, UPDATE_FROM_EXTERNAL_API, UPGRADE_MIGRATION) |
userRemarks |
string |
3.24. ListDataDefinition
| Name | Schema |
|---|---|
empty |
boolean |
listToscaDataDefinition |
< ToscaDataDefinition > array |
ownerId |
string |
3.25. ListDataDefinitionInterfaceOperationParamDataDefinition
| Name | Schema |
|---|---|
empty |
boolean |
listToscaDataDefinition |
< InterfaceOperationParamDataDefinition > array |
ownerId |
string |
3.26. ListDataDefinitionOperationInputDefinition
| Name | Schema |
|---|---|
empty |
boolean |
listToscaDataDefinition |
< OperationInputDefinition > array |
ownerId |
string |
3.27. OperationDataDefinition
| Name | Schema |
|---|---|
creationDate |
integer (int64) |
description |
string |
empty |
boolean |
implementation |
|
inputs |
|
lastUpdateDate |
integer (int64) |
name |
string |
ownerId |
string |
uniqueId |
string |
3.28. OperationInputDefinition
| Name | Schema |
|---|---|
defaultValue |
string |
definition |
boolean |
description |
string |
empty |
boolean |
getInputProperty |
boolean |
getInputValues |
< GetInputValueDataDefinition > array |
hidden |
boolean |
immutable |
boolean |
inputId |
string |
inputPath |
string |
instanceUniqueId |
string |
label |
string |
name |
string |
ownerId |
string |
parentUniqueId |
string |
password |
boolean |
propertyId |
string |
required |
boolean |
schema |
|
schemaType |
string |
status |
string |
type |
string |
uniqueId |
string |
value |
string |
3.29. PolicyDefinition
| Name | Schema |
|---|---|
componentName |
string |
derivedFrom |
string |
description |
string |
empty |
boolean |
invariantName |
string |
invariantUUID |
string |
isFromCsar |
boolean |
name |
string |
normalizedName |
string |
ownerId |
string |
policyTypeName |
string |
policyTypeUid |
string |
policyUUID |
string |
properties |
< PropertyDataDefinition > array |
targets |
< string, < string > array > map |
uniqueId |
string |
version |
string |
3.31. PropertyDataDefinition
| Name | Schema |
|---|---|
defaultValue |
string |
definition |
boolean |
description |
string |
empty |
boolean |
getInputProperty |
boolean |
getInputValues |
< GetInputValueDataDefinition > array |
hidden |
boolean |
immutable |
boolean |
inputId |
string |
inputPath |
string |
instanceUniqueId |
string |
label |
string |
name |
string |
ownerId |
string |
parentUniqueId |
string |
password |
boolean |
propertyId |
string |
required |
boolean |
schema |
|
schemaType |
string |
status |
string |
type |
string |
uniqueId |
string |
value |
string |
3.32. PropertyDefinition
| Name | Schema |
|---|---|
constraints |
< PropertyConstraint > array |
defaultValue |
string |
definition |
boolean |
description |
string |
empty |
boolean |
getInputProperty |
boolean |
getInputValues |
< GetInputValueDataDefinition > array |
hidden |
boolean |
immutable |
boolean |
inputId |
string |
inputPath |
string |
instanceUniqueId |
string |
label |
string |
name |
string |
ownerId |
string |
parentUniqueId |
string |
password |
boolean |
propertyId |
string |
required |
boolean |
schema |
|
schemaType |
string |
status |
string |
type |
string |
uniqueId |
string |
value |
string |
3.33. PropertyRule
| Name | Schema |
|---|---|
empty |
boolean |
ownerId |
string |
rule |
< string > array |
value |
string |
3.34. RegistrationRequest
| Name | Schema |
|---|---|
apiPublicKey |
string |
distEnvEndPoints |
< string > array |
distrEnvName |
string |
isConsumerToSdcDistrStatusTopic |
boolean |
3.36. RelationshipInfo
| Name | Schema |
|---|---|
capability |
string |
capabilityOwnerId |
string |
capabilityUid |
string |
id |
string |
relationship |
|
requirement |
string |
requirementOwnerId |
string |
requirementUid |
string |
3.37. RequirementCapabilityRelDef
| Name | Schema |
|---|---|
fromNode |
string |
relationships |
< CapabilityRequirementRelationship > array |
toNode |
string |
uid |
string |
3.38. RequirementDataDefinition
| Name | Schema |
|---|---|
capability |
string |
empty |
boolean |
leftOccurrences |
string |
maxOccurrences |
string |
minOccurrences |
string |
name |
string |
node |
string |
ownerId |
string |
ownerName |
string |
parentName |
string |
path |
< string > array |
relationship |
string |
source |
string |
uniqueId |
string |
3.39. RequirementDefinition
| Name | Schema |
|---|---|
capability |
string |
empty |
boolean |
leftOccurrences |
string |
maxOccurrences |
string |
minOccurrences |
string |
name |
string |
node |
string |
ownerId |
string |
ownerName |
string |
parentName |
string |
path |
< string > array |
relationship |
string |
source |
string |
uniqueId |
string |
3.40. Resource
| Name | Schema |
|---|---|
abstract |
boolean |
additionalInformation |
< AdditionalInformationDefinition > array |
allArtifacts |
< string, ArtifactDefinition > map |
allVersions |
< string, string > map |
artifacts |
< string, ArtifactDefinition > map |
attributes |
< PropertyDefinition > array |
capabilities |
< string, < CapabilityDefinition > array > map |
categories |
< CategoryDefinition > array |
componentInstances |
< ComponentInstance > array |
componentInstancesAttributes |
< string, < ComponentInstanceProperty > array > map |
componentInstancesInputs |
< string, < ComponentInstanceInput > array > map |
componentInstancesProperties |
< string, < ComponentInstanceProperty > array > map |
componentInstancesRelations |
< RequirementCapabilityRelDef > array |
componentType |
enum (RESOURCE, SERVICE, RESOURCE_INSTANCE, PRODUCT, SERVICE_INSTANCE) |
conformanceLevel |
string |
contactId |
string |
cost |
string |
creationDate |
integer (int64) |
creatorFullName |
string |
creatorUserId |
string |
csarUUID |
string |
csarVersion |
string |
defaultCapabilities |
< string > array |
deploymentArtifacts |
< string, ArtifactDefinition > map |
derivedFrom |
< string > array |
derivedFromGenericType |
string |
derivedFromGenericVersion |
string |
derivedList |
< string > array |
description |
string |
groups |
< GroupDefinition > array |
highestVersion |
boolean |
icon |
string |
importedToscaChecksum |
string |
inputs |
< InputDefinition > array |
interfaceOperations |
< string, InterfaceOperationDataDefinition > map |
interfaces |
< string, InterfaceDefinition > map |
invariantUUID |
string |
isDeleted |
boolean |
lastUpdateDate |
integer (int64) |
lastUpdaterFullName |
string |
lastUpdaterUserId |
string |
licenseType |
string |
lifecycleState |
enum (READY_FOR_CERTIFICATION, CERTIFICATION_IN_PROGRESS, CERTIFIED, NOT_CERTIFIED_CHECKIN, NOT_CERTIFIED_CHECKOUT) |
name |
string |
normalizedName |
string |
policies |
< string, PolicyDefinition > map |
projectCode |
string |
properties |
< PropertyDefinition > array |
requirements |
< string, < RequirementDefinition > array > map |
resourceType |
enum (VFC, VF, CR, CP, PNF, CVFC, VL, VFCMT, Configuration, ServiceProxy, ABSTRACT) |
resourceVendorModelNumber |
string |
systemName |
string |
tags |
< string > array |
topologyTemplate |
boolean |
toscaArtifacts |
< string, ArtifactDefinition > map |
toscaResourceName |
string |
toscaType |
string |
uniqueId |
string |
uuid |
string |
vendorName |
string |
vendorRelease |
string |
version |
string |
3.41. SchemaDefinition
| Name | Schema |
|---|---|
constraints |
< string > array |
derivedFrom |
string |
empty |
boolean |
ownerId |
string |
properties |
< string, PropertyDataDefinition > map |
property |
3.43. SubCategoryDefinition
| Name | Schema |
|---|---|
empty |
boolean |
groupings |
< GroupingDefinition > array |
icons |
< string > array |
name |
string |
normalizedName |
string |
ownerId |
string |
uniqueId |
string |
3.44. TopicRegistrationResponse
| Name | Schema |
|---|---|
distrNotificationTopicName |
string |
distrStatusTopicName |
string |
3.45. TopicUnregistrationResponse
| Name | Schema |
|---|---|
distrNotificationTopicName |
string |
distrStatusTopicName |
string |
notificationUnregisterResult |
enum (OK, CONNNECTION_ERROR, NOT_FOUND, TOPIC_ALREADY_EXIST, OBJECT_NOT_FOUND, INTERNAL_SERVER_ERROR, AUTHENTICATION_ERROR, UNKNOWN_HOST_ERROR) |
statusUnregisterResult |
enum (OK, CONNNECTION_ERROR, NOT_FOUND, TOPIC_ALREADY_EXIST, OBJECT_NOT_FOUND, INTERNAL_SERVER_ERROR, AUTHENTICATION_ERROR, UNKNOWN_HOST_ERROR) |