Web Service Restrictions

Contents

Overview

Overview

Web services are currently restricted as follows:

POST Endpoint: Command Response (admin web service)

The help UI does not support viewing responses for the following epadmin commands via server sent events (SSE). To view the responses in JSON format, copy the location value in the response header to an SSE-supported web browser.

  • stream history

  • browse service

  • dequeue stream

Viewing responses for epadmin enqueue stream command via WebSocket is not supported in the REST API UI. To view the responses in JSON format, copy the location value in the response header to a WebSocket-supported web browser. For example:

POST Endpoint: File Upload (admin web service)

A limitation currently prevents the uploading of generated files from the POST target command endpoint in the UI, when parameters are specified with the sent command. Instead, use a tool such as Postman or curl to upload a generated file.

Get Endpoint: File Download (admin web service)

To download a file that you generated using epadmin (such as epadmin create snapshot) you must specify node directory/system/webservice/ws-file-cache/ {username} as your path to generate the file. You can specify the file name in the download file target. Note: The username is the username of the user that is logged into the browser.

OIDC realm does not work with web service Help UI page (all web services)

The Help UI page generated from a running web service does not currently support the Open ID Connect authentication realm.