Expected responses for OHS initiate health check API

Successfully initiated health check:

{

"message": "OHS Health Check has been initiated successfully"

}

If a health check cannot be initiated, the following responses are possible:

• OHS version information is not present with Hybrid Connector Configuration Service.

  Response:

  {

  "message": "Could not initiate OHS Health check as OHS version is empty. Please restart OHS service or contact administrator to set the OHS version information."

  }

• The OHS version in use is lower than 2.4.0.9 and does not support health check.

  Response:

  {

  "message": "The current OHS version does not support health check. Please upgrade."

  }

• The OHS is not in the Configured state.

  Response:

  {

  "message": "Configure DataSource & OutCome for the OHS and apply the Configurations to Perform Health Check."

  }

• The predefined interval to perform the OHS health check has not yet ended, preventing multiple health check requests for a healthy OHS instance.

  Response:

  {

  "message": "OHS health check has been done recently and it is healthy, please try after some time"

  }

• The server is unable to communicate to the OHS service to initiate a health check.

  Response:

  {

  "message": "Could not Initiate the Health Check as OHS is Down or not in Network."

  }