docs/docs-offeredapis.rst

.. This work is licensed under a Creative Commons Attribution 4.0 International License.


Offered APIs
=================

+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Entity              | Method   | Path Info                                             | Description                                                                                                                                                                               |
+=====================+==========+=======================================================+===========================================================================================================================================================================================+
| 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                                                                                                                                                            |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | - The message contains additional detail in the case of an error, and is empty in the case of success.                                                                                    |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       |                                                                                                                                                                                           |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | Expected:                                                                                                                                                                                 |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | {                                                                                                                                                                                         |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | “statusCode”:200,                                                                                                                                                                         |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | “message”:“health check succeeded”,                                                                                                                                                       |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | “date”:null                                                                                                                                                                               |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | }                                                                                                                                                                                         |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       |                                                                                                                                                                                           |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       |                                                                                                                                                                                           |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       |                                                                                                                                                                                           |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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                                                                                                                                                            |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | - message contains additional detail in the case of an error, and is empty in the case of success.                                                                                        |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | - date string indicating the current date & time                                                                                                                                          |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       |                                                                                                                                                                                           |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | Expected:                                                                                                                                                                                 |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | {                                                                                                                                                                                         |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | “statusCode”:200,                                                                                                                                                                         |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | “message”:“health check succeeded”,                                                                                                                                                       |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | “date”: current date                                                                                                                                                                      |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | }                                                                                                                                                                                         |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       |                                                                                                                                                                                           |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       |                                                                                                                                                                                           |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Change management   | GET      | change-management/workflow {vnfStringsList}           | Get Workflow details for the VNFs list                                                                                                                                                    |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       |                                                                                                                                                                                           |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | Expected HTTP Code 200                                                                                                                                                                    |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       |                                                                                                                                                                                           |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Change management   | GET      | change-management/mso                                 | Get MSO Change Management details                                                                                                                                                         |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       |                                                                                                                                                                                           |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | [{“requestId”:“”,“requestScope”:“vnf”,“requestStatus”:{“percentProgress”:,                                                                                                                |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | “requestState”:“FAILED”,                                                                                                                                                                  |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | “statusMessage”:“Service request FAILED schema validation. No valid vnf-id is specified”,                                                                                                 |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | “finishTime”:“Fri, 20 May 2016 13:36:53 GMT”},                                                                                                                                            |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | “requestType”:“updateInstance”,                                                                                                                                                           |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | “startTime”:“Fri, 20 May 2016 13:36:53 GMT”,                                                                                                                                              |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | “instanceReferences”:{“vnfInstanceName”:“ZRDM1PCRF01”,“vfModuleInstanceName”:“ZRDM1PCRF01-PCRF::base::module-0”,“volumeGroupInstanceId”:“1cc27274-1376-4168-af5d-3e35d1365a4c”}}, {…}…]   |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       |                                                                                                                                                                                           |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | Expected HTTP Code 200                                                                                                                                                                    |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       |                                                                                                                                                                                           |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Change management   | POST     | change-management/workflow/{vnfName}                  | Post workflow request for vnf                                                                                                                                                             |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       |                                                                                                                                                                                           |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | Request body:                                                                                                                                                                             |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       |                                                                                                                                                                                           |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | requestDetails:{                                                                                                                                                                          |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | vnfName: vnfNAME                                                                                                                                                                          |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | vnfInstanceId: ID                                                                                                                                                                         |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | RelatedInstanceList:[ ]                                                                                                                                                                   |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | }                                                                                                                                                                                         |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | requestType:                                                                                                                                                                              |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       |                                                                                                                                                                                           |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | Expected HTTP Code 200                                                                                                                                                                    |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       |                                                                                                                                                                                           |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Change management   | GET      | change-management/scheduler                           | Get Scheduler Change Management Details                                                                                                                                                   |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       |                                                                                                                                                                                           |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | Expected                                                                                                                                                                                  |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | HTTP Code 200                                                                                                                                                                             |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | response: Scheduler details in json                                                                                                                                                       |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       |                                                                                                                                                                                           |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | Explicit HTTP Error Codes                                                                                                                                                                 |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       | 404, 406                                                                                                                                                                                  |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                     |          |                                                       |                                                                                                                                                                                           |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+