[16] REST Interface

DISCLAIMER

As part of the deprecation of Desktop Designer and related legacy visualization- and data pipelines, we have unfortunately had to retire a set of previously documented REST service endpoints. The endpoints below will no longer be available in the product:

· GET media/image/dashboard

· GET media/image/dashboard/part

All Panopticon APIs should be considered proprietary, internal and subject to change. Going forward, all REST endpoints will be classified into private and publicly supported APIs. Please let us know if your implementation relies on REST API, to ensure that the functionality is made available in future public API.

API

Panopticon Real Time exposes services through a REST API. You can use this for scripting and automation, and other tasks like review query statistics and monitor performance.

NOTE	You can use PCLI for some common tasks like upload a workbook and example workbooks to view server performance too.

There are two API groups: the public API which is being built out starting in version 2022.1, and the legacy API. Going forward, new services will only be added to the public API, and old services may migrate there. Other than that, the main differences are:

The public API	The legacy API
· Is officially supported by Altair	· Is "unsupported" in the sense that we cannot guarantee that an endpoint will stay unchanged or even remain between releases
· Will evolve predictably in the future
· Is designed specifically for REST	· Was designed when the server had both REST and SOAP APIs, so is a bit cumbersome from a REST perspective
· Has endpoints that begin with /api, e.g., http://localhost:8080/panopticon/api/user/data/profile	· Has endpoints that begin with /server/rest
· Has documentation in OpenAPI 3 (see https://openapis.org) at /v3/api-docs/public, e.g., http://localhost:8080/panopticon/v3/api-docs/public	· Has documentation in OpenAPI 2 (see https://swagger.io/specification/v2/) at /v2/api-docs
· Has a Swagger UI (see https://swagger.io/tools/swagger-ui/) at /swagger-ui.html, e.g., http://localhost:8080/panopticon/swagger-ui.html	· Has a Swagger UI at /swagger-ui.html, but you need to select the legacy definition in the top bar

NOTE

The API documentation endpoints and Swagger UI are disabled by default. You need to set documentation.enabled=true in Panopticon.properties (and restart the server) to use them. The REST endpoints and services themselves are always enabled. You should never enable the documentation on a production server.