Header Name

Mandatory?

Description

Content-Length

Y

Streamed CSAR payload size

Content-Type

Y

Determines the format of the response body.

Valid value is :  “application/json”

uuid

String

Y

Global Asset Version Identifier: UUID generated by SDC per each version of the asset.

Generated UUID is compliant with RFC 4122. It is a 128-bit value formatted into blocks of hexadecimal digits separated by a hyphen (“-“).

Ex.: AA97B177-9383-4934-8543-0F91A7A02836

invariantUUID

String

Y

Global Asset Identifier: UUID generated by SDC per each asset. This UUID is stays constant along all the asset’s versions

Generated UUID is compliant with RFC 4122. It is a 128-bit value formatted into blocks of hexadecimal digits separated by a hyphen (“-“).

Ex.: AA97B177-9383-4934-8543-0F91A7A02836

name

String

Y

The name of the asset.

Ex. “vMME”

version

String

Y

The asset version in SDC catalog. Two dot (“.”) separated  digit blocks.

The minor version of a asset is incremented every time a designer check-out the asset for an update.

The major version is incremented every time a tester certifies the asset.

Ex. : “2.0”

toscaModelURL

String

Y

Relative asset’s URL. Should be used in REST GET API to download the asset’s CSAR.

The full  URL  will be  in the following format :

https://{serverBaseURL}/{toscaModelPath}

serverBaseURL  - Hostname ( SDC LB FQDN)  + optional port

toscaModelPath -  “toscaModelURL”

Ex : https://sdc.att.com/v1/catalog/services/{uuid}/toscaModel

category

String

Y

Category of the asset. List of Categories at Appendix A

Ex. “VoIP Call Control”

lifecycleState

String

Y

The lifecycle state of the asset. Values are:

NOT_CERTIFIED_CHECKOUT

NOT_CERTIFIED_CHECKIN

READY_FOR_CERTIFICATION

CERTIFICATION_IN_PROGRESS

CERTIFIED

lastUpdaterUserId

String

Y

User ID of the SDC designer who was the last to update the asset for this major version.

distributionStatus

String

Y

Distribution status of the service. Values are:

DISTRIBUTION_NOT_APPROVED

DISTRIBUTION_APPROVED

DISTRIBUTED

DISTRIBUTION_REJECTED

Response code

Service/Policy

Exception

Reason /Description

200

N/A

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

400 

POL5001

Missing  “X-ECOMP-InstanceID”  HTTP header

401 

POL5002

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

403

POL5003

ECOMP component is not authorized 

405

POL4050

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

500 

POL5000

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

serverRoot

string

Server base URL :  hostname+port+base path

Hostname  shall  contain the FQDN  of the SDC  iDNS LB

assetType

string

The requested asset type.

Valid values are: resources /  services

uuid

string

Header Name

Mandatory?

Description

X-ECOMP-RequestID

N

According to the general ECOMP agreement the  "X-ECOMP-RequestID"  header with  the transaction UUID should be published  by ECOMP component calling an  exposed by  other  ECOMP component API in order to  make possible the  transaction traceability across ECOMP.  If it is not sent it will be automatically generated by SDC on request receipt.

X-ECOMP-InstanceID

Y

For  auditing  purpose  each  component  calling  the  SDC API should identify  itself  by sending its  identity  (  e.g. Instar  name ...) in  "X-ECOMP-InstanceID" header . If this header with non-null value is not supplied the HTTP Request will be rejected with '400 Bad Syntax’ response code.

Accept

N

Determines the format of the body of the response. Valid values are :  “application/json”

Authorization

Y

The username and password are formed into one string as “username: password”.  This string is then Base64 encoded to produce the encoded credential which is communicated in the header after the string “Authorization: Basic “.   If the Authorization header is missing, then an HTTP “401 Unauthorized” with ‘WWW-Authenticate’ header specifying the type of required client authentication and realm token will be returned. “401” response  should trigger  the  repeated  HTTP  request  sending with  “Authorization”  header  containing  the  client’s  credentials.

 If  “Authorization”  header is  received  , but  the client‘s authentication fails  (  due to  either  unknown “username”  or invalid “password” )  the  “403 Forbidden”  response  code  will be  returned

Header Name

Mandatory?

Description

Content-Length

Y

Streamed CSAR payload size

Content-Type

Y

Determines the format of the response body.

Valid value is :  “application/json”

uuid

String

Y

Global Asset Version Identifier: UUID generated by SDC per each version of the asset.

Generated UUID is compliant with RFC 4122. It is a 128-bit value formatted into blocks of hexadecimal digits separated by a hyphen (“-“).

Ex.: AA97B177-9383-4934-8543-0F91A7A02836

invariantUUID

String

Y

Global Asset Identifier: UUID generated by SDC per each asset. This UUID is stays constant along all the asset’s versions

Generated UUID is compliant with RFC 4122. It is a 128-bit value formatted into blocks of hexadecimal digits separated by a hyphen (“-“).

Ex.: AA97B177-9383-4934-8543-0F91A7A02836

name

String

Y

The name of the asset.

Ex. “vMME”

version

String

Y

The asset version in SDC catalog. Two dot (“.”) separated  digit blocks.

The minor version of a asset is incremented every time a designer check-out the asset for an update.

The major version is incremented every time a tester certifies the asset.

Ex. : “2.0”

lastUpdaterUserId

String

Y

User ID of the SDC designer who was the last to update the asset for this major version.

lastUpdaterFullName

String

Y

Full name of the SDC designer who was the last to update the asset for this major version

toscaModelURL

String

Y

Relative asset’s URL. Should be used in REST GET API to download the asset’s CSAR.

The full  URL  will be  in the following format :

https://{serverBaseURL}/{toscaModelPath}

serverBaseURL  - Hostname ( SDC LB FQDN)  + optional port

toscaModelPath -  “assetURL”

Ex : https://sdc.att.com/v1/catalog/services/{uuid}/toscaModel

category

String

Y

Category of the asset.

Ex. “VoIP Call Control

distributionStatus

String

Y

Distribution status of the service. Values are:

DISTRIBUTION_NOT_APPROVED

DISTRIBUTION_APPROVED

DISTRIBUTED

DISTRIBUTION_REJECTED

lifecycleState

String

Y

The lifecycle state of the asset. Values are:

NOT_CERTIFIED_CHECKOUT

NOT_CERTIFIED_CHECKIN

READY_FOR_CERTIFICATION

CERTIFICATION_IN_PROGRESS

CERTIFIED

artifacts

List of artifact metadata objects

[1 … unbounded]

Y

List of the asset’s artifacts metadata object

resources

List of resource instances composing service

[1 … unbounded]

Y

Array of resource instance objects.

resourceInstanceName

String

Y

Logical Resource Instance Name  . Unique Identifier of  the instance of the  specific resource in the service context.

resourceName

String

Y

Resource Name

resourceInvariantUUID

String

Y

The invariant UUID of the resource

resourceVersion

String

Y

Resource Version .Two dot (“.”) separated  digit blocks

Ex. : “2.0”

resoucreType

String

{ “VF” ,

 “PNF”,

 “VL” ,

“CP”}

Y

Resource Type  :

• VF (Virtual Function) - A subsystem in a service, it can include one or more VFCs. This is what NFV spec refers as VNF.

• PNF – Physical Network Function. The PNF is modeled in SDC as a resource (similar to VF) that may or may not include CP / VL resources.

• VL (Virtual Link) - Describes the basic topology of the connectivity between one or more VFs (or VFCs in a VF).
• CP (Connection Point) - Represents the virtual and/or physical interface of a VF (or VFC).

resourceUUID

String

Y

Global UUID of the resource that specific artifact belongs to.

It is generated by SDC per each resource version. Generated UUID is compliant with RFC 4122. It is a 128-bit value formatted into blocks of hexadecimal digits separated by a hyphen (“-“).

Ex.: AA97B177-9383-4934-8543-0F91A7A02836

artifacts

List of resource instance artifacts

[1 … unbounded]

Y

Array of  resource instance deployment artifacts.

artifactName

String

Y

Artifact File name

artifactLabel

String

Y

Identifier of the artifact within the VF / Service. artifactLabel must be unique in the VF / Service context.

Format: [a-z0-9] ,Space (‘ ‘) ,Dash (‘-‘)  ,Plus (‘+’)  characters

Note: lower case

artifactType

String

Y

Artifact Type.

 See list of acceptable values in Appendix B

artifactGroupType

String

Y

Whether the artifact is informational or deployment. If the artifact is “deployment” artifact, it will be distributed when service is distributed.

Valid values: “DEPLOYMENT” / “INFORMATIONAL”

artifactURL

String

Y

Relative artifact’s URL. Should be used in REST GET API to download the artifact’s payload.

The full  artifact URL  will be  in the following format :

https://{serverBaseURL}/{resourcePath}

serverBaseURL  - Hostname ( SDC LB FQDN)  + optional port

resourcePath -  “artifactURL”

Please see 6.4 for the DownloadArtifact URLs

Ex : https://sdc.att.com/v1/catalog/resources/{uuid}/artifacts{artifactUUID}

artifactDescription

String

Y

Artifact Description.

artifactTimeout

Integer

N

 Will be populated only if its value is not 0.

artifactChecksum

String

Y

Base-64 encoded MD5 checksum of the artifact’s payload.

 Should be used for data integrity validation when an artifact’s payload is downloaded.

artifactUUID

String

Y

Global UUID generated by SDC each time  when artifact payload is  updated. Generated UUID is compliant with RFC 4122.

It is a 128-bit value formatted into blocks of hexadecimal digits separated by a hyphen (“-“).

Ex. : AA97B177-9383-4934-8543-0F91A7A02836

artifactVersion

String

Y

Service Version . One digit block ( major version only) .

Changed each time when artifact payload is updated.

Ex. : “2”

generatedFromUUID

String

N

This attribute will be  sent only  in the case of  an artifact  generated on basis of  other artifact ( e.x.  HEAT /HEAT_VOL/HEAT_NET  and  their  HEAT_ENV artifacts) .  It will publish the  Global UUID of  the artifact that the given artifact is  generated from .

Response code

Service/Policy

Exception

Reason /Description

200

N/A

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

400 

POL5001

Missing  “X-ECOMP-InstanceID”  HTTP header

401 

POL5002

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

403

POL5003

ECOMP component is not authorized 

404

SVC4063

Error: Requested '%1' resource was not found.

405

POL4050

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

500 

POL5000

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

serverRoot

string

Server base URL :  hostname+port+base path

Hostname  shall  contain the FQDN  of the SDC  iDNS LB

relativeToscaModelURL

string

Relative Catalog Asset’s URL published in the metadata object

Header Name

Mandatory?

Description

X-ECOMP-RequestID

N

According to the general ECOMP agreement the  "X-ECOMP-RequestID"  header with  the transaction UUID should be published  by ECOMP component calling an  exposed by  other  ECOMP component API in order to  make possible the  transaction traceability across ECOMP.  If it is not sent it will be automatically generated by SDC on request receipt.

X-ECOMP-InstanceID

Y

For  auditing  purpose  each  component  calling  the  SDC API should identify  itself  by sending its  identity  (  e.g. Instar  name ...) in  "X-ECOMP-InstanceID" header . If this header with non-null value is not supplied the HTTP Request will be rejected with '400 Bad Syntax’ response code.

Accept

N

Determines the format of the body of the response. Valid values are :  “application/json”

Authorization

Y

The username and password are formed into one string as “username: password”.  This string is then Base64 encoded to produce the encoded credential which is communicated in the header after the string “Authorization: Basic “.   If the Authorization header is missing, then an HTTP “401 Unauthorized” with ‘WWW-Authenticate’ header specifying the type of required client authentication and realm token will be returned. “401” response  should trigger  the  repeated  HTTP  request  sending with  “Authorization”  header  containing  the  client’s  credentials.

 If  “Authorization”  header is  received  , but  the client‘s authentication fails  (  due to  either  unknown “username”  or invalid “password” )  the  “403 Forbidden”  response  code  will be  returned

Header Name

Mandatory?

Description

Content-Type

Y

Specifies the  downloaded payload format as “ arbitrary data in binary format” .Valid value is : application/octet-stream

Content-Length

Y

Streamed CSAR payload size

Content-Disposition

Y

Specifies  the name of  file to  store the  downloaded CSAR’s  payload  ( RFC 2183) .Valid value format : “attachement,filename=”{csarName}””

Content-MD5

Y

The value for this header must be the MD5 checksum of the csar provided

TOSCA-Meta-File-Version: 1.0

CSAR-Version: 1.1

Created-By: AT&T

Entry-Definitions: Definitions/<asset type>-<asset system name>-template.yml

Folder Name

Mandatory?

Description

TOSCA-Metadata

Y

This folder contains the TOSCA.meta metadata file which provides the entry information of the CSAR

Definitions

Y

This folder contains the main TOSCA yaml representation of the asset. The main yaml can be referring to other TOSCA yaml files that should also be in this folder.

This folder should also contain the TOSCA yaml of all the types that are used in the main yaml of the asset (capability_type, data_type, node_type etc.)

Artifacts

N

This folder contains all deployment artifacts of the asset

Response code

Service/Policy

Exception

Reason /Description

200

N/A

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

400 

POL5001

Missing  “X-ECOMP-InstanceID”  HTTP header

401 

POL5002

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

403

POL5003

ECOMP component is not authorized 

404

SVC4063

Error: Requested '%1' resource was not found.

405

POL4050

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

500 

POL5000

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