System Health Check - Intergraph Smart 3D Web API - Installation & Upgrade - Hexagon PPM

Intergraph Smart 3D Web API Installation and Configuration

PPMProduct
Intergraph Smart 3D Web API
PPMCategory_custom
Installation & Upgrade
Version_SThreeD_Custom
12 (2018)

The available unsecured diagnostic endpoints are described below (URLs are derived from the Sample API). You do not need an access token to call the resources.

  • POST https://localhost:44313/S3d/v1/diagnostic/echo

    Tests network latency by emulating the ping protocol. The diagnostic/echo resource reads and returns the content of the request message body with an HTTP 200 status code. To measure performance, the calling client can measure the elapsed time between sending the request message and receiving the response message. The client can also provide some payload to see if message size affects the round-trip time.

  • POST https://localhost:44313/S3d/v1/diagnostic/upload

    Tests upload speed. The diagnostic/upload resource reads the content of the request message body and responds with an HTTP 204 status code and empty body. To measure performance, the calling client can calculate the elapsed time between sending the request message and receiving the response message, and then divides the number of uploaded bytes by that time.

  • GET https://localhost:44313/S3d/v1/diagnostic/download?contentBytes=131072

    Tests download speed. The diagnostic/download resource accepts the request and responds with an HTTP 200 status code and a random set of bytes in the message body. The response size is controlled by the contentBytes query parameter. If the parameter is missing the service responds with 65536 bytes (64 KB) content. To measure performance, the calling client can calculate the elapsed time between sending the request message and receiving the response message, and then divides the number of downloaded bytes by that time.

  • GET https://localhost:44313/S3d/v1/diagnostic/status

    Checks overall health status. The diagnostic/status resource responds with an HTTP 200 status code and an OK string in the message body if the API is functional. It responds with an HTTP 500 status code and an UNHEALTHY string in the message body if the API is not fully functional. Any other response (such as no response due to timeout) also indicates a non-healthy state.

For the status check URL, you must have Redis installed and configured to properly use this call. Otherwise, the call always returns Healthy.

Unhealthy returns log an error code in C:\inetpub\logs\LogFiles\NLog_S3DWebApi_ErrorLog.log along with the computer name, Site Alias, and Plant Name of the instance that failed. If the Web Service instance is in error, then the returned error codes are written to the logs. The error codes are:

  • UnknownError / -1 - The Web service instance has failed due to an error that we have not seen before or for which have created an appropriate error code. For more information, try to run the test configuration feature of the configuration utility or contact customer support.

  • LossOfDatabaseConnection/ -2 - The Web service instance lost the connection to the database for an extended period. Check the status of your database server and database.

  • RabbitMqConnection / -3 - The Web service instance‚Äôs RabbitMq connection has failed and resulted in errors within the service. Try restarting the RabbitMq service.

  • CannotConnectToSite / -4 - The Web service instance cannot create a connection to the Smart 3D site database. Check the status of your site database.

  • CannotConnectToModel/ -5 - The Web service instance cannot create a connection to the model database. Check the status of your model database.

  • RedisConnection/ -6 - The Web service instance has failed to establish a functional Redis Connection or to the local cache, depending on your configuration. If you have Redis configured, try restarting the service. Otherwise, you need to investigate why it is failing to save to your local cache.

  • MissingMetadata/ -7 - The Web service instance is missing metadata. Generate your metadata through the Smart 3D Web API Configuration Tool.

  • InvalidParameters/ -9 - The Web service instance has received invalid parameters on startup. Check your configuration and try restarting the service manager.

  • CannotConnectToConfiguration/ -10 - The Web service instance cannot connect to the database for configuration information. Use the Smart 3D Web API Configuration Tool to check the configuration. Verify that the user running the service manager has database access.

    If you still encounter issues, try using the Smart 3D Web API Configuration Tool test setup feature to diagnose the problem.