1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
8 +---------------------+----------+-------------------------------------------------------+------------------------------------------------------------------------------------------+
9 | Entity | Method | Path Info | Description |
10 +=====================+==========+=======================================================+==========================================================================================+
11 | Health Check | GET | /healthCheck | The Health Status of the application checks the DB connection. |
12 +---------------------+----------+-------------------------------------------------------+------------------------------------------------------------------------------------------+
13 | | | | | Used by IDNS for redundancy |
15 | | | | | return response entity: |
16 | | | | | - statusCode Either 200 or 500 |
17 | | | | | - detailedMsg of the result, in case of failure particular error message |
21 | | | | .. code-block:: javascript |
24 | | | | "statusCode": 200, |
25 | | | | "detailedMsg": "health check succeeded", |
26 | | | | "date": current date |
29 +---------------------+----------+-------------------------------------------------------+------------------------------------------------------------------------------------------+
30 | Health Check | GET | rest/healthCheck/{User-Agent}/{X-ECOMP-RequestID} | The Health Status of the application checks the DB connection |
31 +---------------------+----------+-------------------------------------------------------+------------------------------------------------------------------------------------------+
32 | | | | | return response entity: |
33 | | | | | - statusCode Either 200 or 500 |
34 | | | | | - detailedMsg of the result, in case of failure particular error message |
35 | | | | | - date string indicating the current date & time |
39 | | | | .. code-block:: javascript |
42 | | | | "statusCode": 200, |
43 | | | | "detailedMsg": "health check succeeded", |
44 | | | | "date": current date |
47 +---------------------+----------+-------------------------------------------------------+------------------------------------------------------------------------------------------+
48 | Commit Version | GET | /commitInfo | Displays info about the last commit of the running build |
49 +---------------------+----------+-------------------------------------------------------+------------------------------------------------------------------------------------------+
50 | | | | | return response entity: |
51 | | | | | - commitId full id of the commit |
52 | | | | | - commitMessageShort short message from the commit |
53 | | | | | - commitTime time of the commit |
57 | | | | .. code-block:: javascript |
60 | | | | "commitId": id of the last commit |
61 | | | | "commitMessageShort": short message of the last commit |
62 | | | | "commitTime": time of the last commit |
65 +---------------------+----------+-------------------------------------------------------+------------------------------------------------------------------------------------------+
68 .. _vid-maintenance-apis:
73 +---------------------+----------+-------------------------------------------------------+------------------------------------------------------------------------------------------+
74 | Maintenance: | POST | /maintenance/category_parameter/{categoryName} | Populate VID Project/Owning entity/Line of Business/Platform drop downs |
75 | Category Parameters | | | |
76 +---------------------+----------+-------------------------------------------------------+------------------------------------------------------------------------------------------+
77 | | | | ``{categoryName}`` is one of lineOfBusiness, platform, project, owningEntity. |
81 | | | | .. code-block:: javascript |
84 | | | | "options": [ <list of strings> ] |
87 +---------------------+----------+-------------------------------------------------------+------------------------------------------------------------------------------------------+