SO

Interface to Service Orchestrator (SO) for various Operations - for example orchestrating a new VNF.

SO API

SDC

Interface to Service Design Catalog (SDC) for getting Service Model

SDC API,

https://docs.onap.org/projects/onap-sdc/en/latest/offeredapis.html

A&AI

Interface to Active & Available Inventory (A&AI) for managing Service Instances - For example for Change Management.

AAI REST API Documentation - Honolulu

Health Check

GET

/healthCheck

The Health Status of the application checks the DB connection.

Used by IDNS for redundancy

return response entity:
- statusCode Either 200 or 500
- detailedMsg of the result, in case of failure particular error message

Expected:

^{{ "statusCode": 200, "detailedMsg": "health check succeeded", "date": current date }}

Health Check

GET

rest/healthCheck/{User-Agent}/{X-ECOMP-RequestID}

The Health Status of the application checks the DB connection

return response entity:
- statusCode Either 200 or 500
- detailedMsg of the result, in case of failure particular error message
- date string indicating the current date & time

Expected:

^{{ "statusCode": 200, "detailedMsg": "health check succeeded", "date": current date }}

Commit Version

GET

/commitInfo

Displays info about the last commit of the running build

return response entity:
- commitId full id of the commit
- commitMessageShort short message from the commit
- commitTime time of the commit

Expected:

^{{ "commitId": id of the last commit "commitMessageShort": short message of the last commit "commitTime": time of the last commit }}

Maintenance: Category Parameters

POST

/maintenance/category_parameter/{categoryName}

Populate VID Project/Owning entity/Line of Business/Platform drop downs

{categoryName} is one of lineOfBusiness, platform, project, owningEntity.

POST body:

^{{ "options": [ <list of strings> ] }}