serverRoot

Y

Server base URL :  hostname+port+base path

id

Y

The id of the Activity Spec 

versionId

Y

The Activity Spec version in SDC.

Two dot (“.”) separated digit blocks.

value "latest" will bring the latest version

Note: lower case

Header Name

Mandatory?

Description

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.

Ex. onap-test

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

OOS

Header Name

Mandatory

Description

Content-Type

Y

Determines the format of the response body.

Valid value is :  “application/json”

Content-Length

Y

Length of  the response body

name

Y 

Name of the Activity Spec passed as part of Request Body

categoryList

Y

status

Y

Activity Spec version = Certified

inputParameters

Y 

Input Parameters to the request boday(Parameter Name  as Key and Parameter value as value) 

outputParamters 

N/A

200

OK

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

Actually for this policy following error description is implemented:
Error: Authentication is required to use the API.

403

POL5003

ECOMP component is not authorized

Actually for this policy following error description is implemented:
Error: Not authorized to use the API

404

SVC4063

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

404

SVC4505

activity spec 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.

The component should continue the attempts to get the needed information.