Introduction

For customers who are self-hosting PrizmDoc Server, the health REST API allows an administrator or application to check the health of a PrizmDoc Server instance.

Available URLs

GET /PCCIS/V1/Service/Current/Health

Determines whether or not a specific PrizmDoc Server instance is healthy.

Response

You can use the HTTP status code to determine the health of the instance:

You can also determine health by looking at the response body. When healthy, the response body will be plaintext with a value of OK. When unhealthy, the response will have no body.

NOTE: If PrizmDoc Viewer has just started, unhealthy status may be returned for a short time until the system has completely started up.

Example

Request

GET http://prizmdoc_server_base_url/PCCIS/V1/Service/Current/Health

Response

HTTP/1.1 200 OK

OK

GET /PCCIS/V1/Service/Current/Info

Gets metadata about the current status of a specific PrizmDoc Server instance.

NOTE: Do not take any actions when any child service reports unhealthy status. PrizmDoc Server has its own mechanism to recover.

Successful Response

Response Body

JSON with the following:

• serviceStatus (String) Status of PrizmDoc Server:
  • "starting"
  • "running"
  • "unhealthy"
• licenseStatus (String) Information about the PrizmDoc Server License:
  • "retrieving" - Returned when the product is starting and the licensed status is not yet known.
  • "unlicensed" - Returned when the provided license key is not valid. Your license may be expired, or you may not have correctly configured your license key.
  • "licensed as 'Your Solution Name'" - Returned when a valid license key is found. Your Solution Name will be replaced with the value of your actual solution name.
• instances[] (Array of Objects) Objects describing the PrizmDoc Server instances that are currently running. Items contain:
  • serviceStatus (String) Status of the PrizmDoc Server used for viewing.
  • serviceInstallerVersion (String) Version of the installer used to install PrizmDoc Server.
  • pccisVersion (String) Version of the PrizmDoc Server used for viewing.
  • runtimeVersion (String) .NET runtime version supporting the PrizmDoc Server used for viewing.
  • operatingSystem (String) Operating System of the server on which PrizmDoc Server is running.
  • startTime (String) Last recorded time the PrizmDoc Server were started. Time is reported in UTC and is ISO-8601 format.
  • instanceId (String) Host name of the server running PrizmDoc Server.
  • childServices[] (Array of Objects) Objects describing the health status for each individual PrizmDoc Service. > NOTE: It's important not to programmatically depend upon the value of a Service name because the total number of items in the childServices array may change from release to release (items may be added or removed). Items may contain:
    • name (String) Name of the child PrizmDoc Service.
    • status (String) Status of the child PrizmDoc Service:
      • "starting"
      • "running"
      • "unhealthy"

Example

Request

GET http://prizmdoc_server_base_url/PCCIS/V1/Service/Current/Info

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "serviceStatus": "running",
  "licenseStatus": "licensed as 'Acme Inc.'",
  "instances": [
    {
      "serviceStatus": "running",
      "serviceInstallerVersion": "XX.X.XX.XXX",
      "pccisVersion": "XX.X.XX.XXXX",
      "runtimeVersion": "4.0.30319.34014",
      "operatingSystem": "Microsoft Windows NT 6.3.9600.0",
      "startTime": "1971-01-01T00:00:00.0Z",
      "instanceId": "myhostname",
      "childServices": [
        {
          "name": "PCC Error Reporting Service",
          "serviceStatus": "running"
        },
        {
          "name": "PCC Imaging Conversion Service",
          "serviceStatus": "running",
          "version": "X.X.XXXX.XXXX"
        },
        {
          "name": "PCC PDF Processing Service",
          "serviceStatus": "running"
        },
        {
          "name": "PCC Raster Conversion Service",
          "serviceStatus": "running",
          "version": "X.X.XXXX.XXXX"
        },
        {
          "name": "PCC Vector Conversion Service",
          "serviceStatus": "running",
          "version": "X.X.XXXX.XXXX"
        },
        {
          "name": "PCC Html Conversion Service",
          "serviceStatus": "running",
          "version": "X.X.XXXX.XXXX"
        },
        {
          "name": "PCC Work File Service",
          "serviceStatus": "running",
          "version": "X.X.X"
        },
        {
          "name": "PCC Office Conversion Service",
          "serviceStatus": "running",
          "version": "X.XX.XXXX.XXXX"
        },
        {
          "name": "PCC Format Detection Service",
          "serviceStatus": "running"
        },
        {
          "name": "PCC AutoRedaction Service",
          "serviceStatus": "running"
        },
        {
          "name": "PCC Redaction Service",
          "serviceStatus": "running",
          "version": "X.X.X"
        },
        {
          "name": "PCC Email Processing Service",
          "serviceStatus": "running"
        },
        {
          "name": "PCC Email Conversion Service",
          "serviceStatus": "running",
          "version": "X.X.XXXX.XXXX"
        },
        {
          "name": "PCC Content Conversion Service",
          "serviceStatus": "running"
        },
        {
          "name": "configuration-service",
          "serviceStatus": "running"
        },
        {
          "name": "licensing-service",
          "serviceStatus": "running"
        },
        {
          "name": "health-service",
          "serviceStatus": "running"
        }
      ]
    }
  ]
}