Overview of the ObjectServer HTTP interface

The HTTP interface is a lightweight Application Programming Interface (API) that is hosted in the ObjectServer. The HTTP interface provides access to table data in the ObjectServer through a structured URI format that uses HTTP. POST, PATCH, GET, and DELETE requests. Requests are supported against table URIs or row URIs. Access to the URI is authenticated by a known ObjectServer user through basic HTTP authentication The interface can be secured through an HTTPS connection. You can enable the interface by setting properties in the ObjectServer.

Base URI

The base URI for the HTTP interface is as follows.

http://host:port/objectserver/restapi/

AlertsUser role

For users to perform actions through the API interface, specific roles must be applied. The AlertsUser role needs to be assigned to any users connecting in through the HTTP API, as this role is required for read-only access. If write (update and delete) access is required, the CatalogUser role must also be applied.

Only the AlertsUser role should be assigned for view permissions (do not include the CatalogUser role).