docs/offeredapis.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2
   3
   4 Offered APIs
   5 =================
   6
   7 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   8 | Entity              | Method   | Path Info                                             | Description                                                                                                                                                                               |
   9 +=====================+==========+=======================================================+===========================================================================================================================================================================================+
  10 | Health Check        | GET      | /healthCheck                                          | The Health Status of the application checks the DB connection.                                                                                                                            |
  11 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  12 |                     |          |                                                       | Used by IDNS for redundancy                                                                                                                                                               |
  13 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  14 |                     |          |                                                       |                                                                                                                                                                                           |
  15 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  16 |                     |          |                                                       | return response entity:                                                                                                                                                                   |
  17 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  18 |                     |          |                                                       | - statusCode Either 200 or 500                                                                                                                                                            |
  19 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  20 |                     |          |                                                       | - The message contains additional detail in the case of an error, and is empty in the case of success.                                                                                    |
  21 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  22 |                     |          |                                                       |                                                                                                                                                                                           |
  23 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  24 |                     |          |                                                       | Expected:                                                                                                                                                                                 |
  25 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  26 |                     |          |                                                       | {                                                                                                                                                                                         |
  27 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  28 |                     |          |                                                       | “statusCode”:200,                                                                                                                                                                         |
  29 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  30 |                     |          |                                                       | “message”:“health check succeeded”,                                                                                                                                                       |
  31 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  32 |                     |          |                                                       | “date”:null                                                                                                                                                                               |
  33 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  34 |                     |          |                                                       | }                                                                                                                                                                                         |
  35 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  36 |                     |          |                                                       |                                                                                                                                                                                           |
  37 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  38 |                     |          |                                                       |                                                                                                                                                                                           |
  39 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  40 |                     |          |                                                       |                                                                                                                                                                                           |
  41 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  42 | Health Check        | GET      | rest/healthCheck/{User-Agent}/{X-ECOMP-RequestID}     | The Health Status of the application checks the DB connection                                                                                                                             |
  43 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  44 |                     |          |                                                       |                                                                                                                                                                                           |
  45 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  46 |                     |          |                                                       | return response entity:                                                                                                                                                                   |
  47 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  48 |                     |          |                                                       | - statusCode Either 200 or 500                                                                                                                                                            |
  49 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  50 |                     |          |                                                       | - message contains additional detail in the case of an error, and is empty in the case of success.                                                                                        |
  51 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  52 |                     |          |                                                       | - date string indicating the current date & time                                                                                                                                          |
  53 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  54 |                     |          |                                                       |                                                                                                                                                                                           |
  55 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  56 |                     |          |                                                       | Expected:                                                                                                                                                                                 |
  57 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  58 |                     |          |                                                       | {                                                                                                                                                                                         |
  59 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  60 |                     |          |                                                       | “statusCode”:200,                                                                                                                                                                         |
  61 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  62 |                     |          |                                                       | “message”:“health check succeeded”,                                                                                                                                                       |
  63 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  64 |                     |          |                                                       | “date”: current date                                                                                                                                                                      |
  65 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  66 |                     |          |                                                       | }                                                                                                                                                                                         |
  67 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  68 |                     |          |                                                       |                                                                                                                                                                                           |
  69 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  70 |                     |          |                                                       |                                                                                                                                                                                           |
  71 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  72 | Change management   | GET      | change-management/workflow {vnfStringsList}           | Get Workflow details for the VNFs list                                                                                                                                                    |
  73 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  74 |                     |          |                                                       |                                                                                                                                                                                           |
  75 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  76 |                     |          |                                                       | Expected HTTP Code 200                                                                                                                                                                    |
  77 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  78 |                     |          |                                                       |                                                                                                                                                                                           |
  79 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  80 | Change management   | GET      | change-management/mso                                 | Get MSO Change Management details                                                                                                                                                         |
  81 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  82 |                     |          |                                                       |                                                                                                                                                                                           |
  83 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  84 |                     |          |                                                       | [{“requestId”:“”,“requestScope”:“vnf”,“requestStatus”:{“percentProgress”:,                                                                                                                |
  85 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  86 |                     |          |                                                       | “requestState”:“FAILED”,                                                                                                                                                                  |
  87 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  88 |                     |          |                                                       | “statusMessage”:“Service request FAILED schema validation. No valid vnf-id is specified”,                                                                                                 |
  89 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  90 |                     |          |                                                       | “finishTime”:“Fri, 20 May 2016 13:36:53 GMT”},                                                                                                                                            |
  91 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  92 |                     |          |                                                       | “requestType”:“updateInstance”,                                                                                                                                                           |
  93 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  94 |                     |          |                                                       | “startTime”:“Fri, 20 May 2016 13:36:53 GMT”,                                                                                                                                              |
  95 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  96 |                     |          |                                                       | “instanceReferences”:{“vnfInstanceName”:“ZRDM1PCRF01”,“vfModuleInstanceName”:“ZRDM1PCRF01-PCRF::base::module-0”,“volumeGroupInstanceId”:“1cc27274-1376-4168-af5d-3e35d1365a4c”}}, {…}…]   |
  97 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  98 |                     |          |                                                       |                                                                                                                                                                                           |
  99 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 100 |                     |          |                                                       | Expected HTTP Code 200                                                                                                                                                                    |
 101 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 102 |                     |          |                                                       |                                                                                                                                                                                           |
 103 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 104 | Change management   | POST     | change-management/workflow/{vnfName}                  | Post workflow request for vnf                                                                                                                                                             |
 105 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 106 |                     |          |                                                       |                                                                                                                                                                                           |
 107 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 108 |                     |          |                                                       | Request body:                                                                                                                                                                             |
 109 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 110 |                     |          |                                                       |                                                                                                                                                                                           |
 111 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 112 |                     |          |                                                       | requestDetails:{                                                                                                                                                                          |
 113 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 114 |                     |          |                                                       | vnfName: vnfNAME                                                                                                                                                                          |
 115 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 116 |                     |          |                                                       | vnfInstanceId: ID                                                                                                                                                                         |
 117 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 118 |                     |          |                                                       | RelatedInstanceList:[ ]                                                                                                                                                                   |
 119 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 120 |                     |          |                                                       | }                                                                                                                                                                                         |
 121 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 122 |                     |          |                                                       | requestType:                                                                                                                                                                              |
 123 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 124 |                     |          |                                                       |                                                                                                                                                                                           |
 125 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 126 |                     |          |                                                       | Expected HTTP Code 200                                                                                                                                                                    |
 127 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 128 |                     |          |                                                       |                                                                                                                                                                                           |
 129 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 130 | Change management   | GET      | change-management/scheduler                           | Get Scheduler Change Management Details                                                                                                                                                   |
 131 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 132 |                     |          |                                                       |                                                                                                                                                                                           |
 133 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 134 |                     |          |                                                       | Expected                                                                                                                                                                                  |
 135 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 136 |                     |          |                                                       | HTTP Code 200                                                                                                                                                                             |
 137 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 138 |                     |          |                                                       | response: Scheduler details in json                                                                                                                                                       |
 139 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 140 |                     |          |                                                       |                                                                                                                                                                                           |
 141 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 142 |                     |          |                                                       | Explicit HTTP Error Codes                                                                                                                                                                 |
 143 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 144 |                     |          |                                                       | 404, 406                                                                                                                                                                                  |
 145 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 146 |                     |          |                                                       |                                                                                                                                                                                           |
 147 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+