Help Center

REST API

The REST APIs are available for developers and system administrators who wish to integrate Prognosis data into 3rd party applications or to provide limited access to Prognosis configurations using scripts or customer developed applications.

This REST API provides access using standard HTTP requests and requires the responses to be parsed using either of the 2 supported output formats, JSON or XML.

This section provides the REST data API's available. It documents the method calls and request & response formats, because REST is based on open standards, it is possible to use any development language to access the API.

Current REST Version

The current version for the REST API is "v1".

Where {ver} is specified within these pages, it should be replaced with "v1".

REST Resources

Request Parameters

Within the REST API pages, each method specifies the parameters required for each request, these parameters can be one of the following

URLThese parameters are specified in the URL and identify a resource on the server to request.
QueryThese parameters are specified in the URL in the Query String part of the URL.  i.e. following the '?'. They are always a <key>=<value> pair. The key is the name of the parameter, the value must be supplied.
Body

This is the payload of the request, and the format is based on the content-type of the request. Only 2 payload types are supported, application/xml and application/json

These parameters must be supplied in the payload, see the REST Resources for examples.

Authorization and Security

Access to the Rest API is restricted to users as defined in the Web Application - Administration 'Security' configuration. The authenticated user must belong to a defined Role. The Role will specify the permissions and features available to the user.

The documented API's will provide details of the permissions required to use each REST function call.

Two modes of authentication are supported, one of these must be used:

  • HTTP Basic authentication for 3rd party client calls outside the context of the Web Application (via 'Authorize' HTTP header).
  • Web session as supported by the Web Application (via Forms authentication - ie, log into the Web Application from the browser).  If the Rest API request contains the cookie that belongs to the existing Web Application session, the cookie will be accepted and the role will be recognized and authenticated.

Error Handling and Debugging

The REST API follows RFC 2616 for error handling. Logging is also provided for the REST API calls and can be found in <Prognosis_Home>\WebUI\IIS\Logs.

Swagger Interface

The Swagger interface provides an easy way to test and use the REST API's. This interface is accessible after logging in to the Web Application and then modifying the browser URL Address to:

https://<prognosis-server>/Prognosis/swagger

For details about using Swagger please refer to the Swagger web site: http://swagger.io


Provide feedback on this article