1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
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 |
14 | | | | | return response entity: |
15 | | | | | - statusCode Either 200 or 500 |
16 | | | | | - detailedMsg of the result, in case of failure particular error message |
20 | | | | .. code-block:: javascript |
23 | | | | "statusCode": 200, |
24 | | | | "detailedMsg": "health check succeeded", |
25 | | | | "date": current date |
28 +---------------------+----------+-------------------------------------------------------+------------------------------------------------------------------------------------------+
29 | Health Check | GET | rest/healthCheck/{User-Agent}/{X-ECOMP-RequestID} | The Health Status of the application checks the DB connection |
30 +---------------------+----------+-------------------------------------------------------+------------------------------------------------------------------------------------------+
31 | | | | | return response entity: |
32 | | | | | - statusCode Either 200 or 500 |
33 | | | | | - detailedMsg of the result, in case of failure particular error message |
34 | | | | | - date string indicating the current date & time |
38 | | | | .. code-block:: javascript |
41 | | | | "statusCode": 200, |
42 | | | | "detailedMsg": "health check succeeded", |
43 | | | | "date": current date |
46 +---------------------+----------+-------------------------------------------------------+------------------------------------------------------------------------------------------+
47 | Commit Version | GET | /commitInfo | Displays info about the last commit of the running build |
48 +---------------------+----------+-------------------------------------------------------+------------------------------------------------------------------------------------------+
49 | | | | | return response entity: |
50 | | | | | - commitId full id of the commit |
51 | | | | | - commitMessageShort short message from the commit |
52 | | | | | - commitTime time of the commit |
56 | | | | .. code-block:: javascript |
59 | | | | "commitId": id of the last commit |
60 | | | | "commitMessageShort": short message of the last commit |
61 | | | | "commitTime": time of the last commit |
64 +---------------------+----------+-------------------------------------------------------+------------------------------------------------------------------------------------------+
67 .. _vid-maintenance-apis:
72 +---------------------+----------+-------------------------------------------------------+------------------------------------------------------------------------------------------+
73 | Maintenance: | POST | /maintenance/category_parameter/{categoryName} | Populate VID Project/Owning entity/Line of Business/Platform drop downs |
74 | Category Parameters | | | |
75 +---------------------+----------+-------------------------------------------------------+------------------------------------------------------------------------------------------+
76 | | | | ``{categoryName}`` is one of lineOfBusiness, platform, project, owningEntity. |
80 | | | | .. code-block:: javascript |
83 | | | | "options": [ <list of strings> ] |
86 +---------------------+----------+-------------------------------------------------------+------------------------------------------------------------------------------------------+