Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Page Status: Updated for Istanbul -  

...

Drawio
bordertrue
diagramNamevid_r10r11
simpleViewerfalse
width
linksauto
tbstyletop
lboxtrue
diagramWidth851
revision12


2. Component API definitions

...

EntityMethodPath InfoDescription
Health CheckGET/healthCheckThe 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 CheckGETrest/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 VersionGET/commitInfoDisplays 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 APIs

...

Maintenance: Category ParametersPOST/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> ]
}

Next  Previous

3. Component Description:

...