Health and Information

The following are APIs for checking the health status of the PirzmDoc Application Services service, as well as checking whether it is properly configured to connect with a PrizmDoc Server. Additionally an API is provided to return information about the PrizmDoc Application Services service.

Note that these routes do not have route keys, as they cannot be re-routed.

GET /health

Note that this URL is only available with Self-Hosted PrizmDoc.

A check to determine if the service is up and running.

GET http://localhost:3000/health

Successful Response:

200 OK
OK

There are no error states for this request. If the request times out or the connection is refused, then the service is not running or reachable.

GET /servicesConnection

Note that this URL is only available with Self-Hosted PrizmDoc.

Returns the status of the Application Services connectivity to PrizmDoc Server, whether self-hosted or configured through an Accusoft-hosted PrizmDoc Server.

Successful Response:

200 OK
OK

Note that this response represents that the connection to the back-end service is successful, and does not take into account whether those services are healthy. If you need to check the health of those services, please make a call to them directly.

Errored Responses:

This response represents that PAS is not properly configured to communicate with a Prizm back-end service.

GET /info

Note that this URL is only available with Self-Hosted PrizmDoc.

A request to get information about the service.

GET http://localhost:3000/info

Successful Response:

200 OK
Content-Type: application/json
{
    "version": "X.X.XXXX.XXXX"
}

Where the version is the PrizmDoc Application Service version.

There are no error states for this request. If the request times out or the connection is refused, then the service is not running or reachable.