Get Metadata of a Stream or Window

Use this REST request to get the metadata of a stream or window to which you wish to connect. This REST request is a POST type request.

Header

http://serverDetails/espws/restservice/stream/<stream/windowname>?action=get&workspace=<workspaceName>&project=<projectName>

Body

Connection Details
Element Description
connectionDetails

(Required) Element containing cluster, port, and authentication details below.

clusterName

Type: string

(Required) The name of the cluster on which the project that you wish to update is running.

port

Type: integer

(Required) Specify the port on which the cluster is running.

authentication

(Required) Element containing authentication details.

type

Type: string

(Required) Specify the type of authentication the ESP Server is using. Valid values are user, rsa, and kerberos.

data

Type: string

(Required) Specify a value based on the type of authentication you specified in the type element. For example,
  • for user, specify username:password valued
  • for rsa, specify keystore:user:password values. For the keystore value, enter the full path to the keystore file. If you are using Windows, surround the file path in single quotation marks.
  • for kerberos, specify user:service:cache values. For the cache value, enter the full path to the Kerberos cache file. If you are using Windows, surround the file path in single quotation marks.
sslEnabled

Type: boolean

(Required) Specify whether SSL is enabled on the cluster on which the project is running. The default value is false.

Example

Header
http://localhost:9091/espws/restservice/stream/mystream?action=get&workspace=default&project=my_project
Body
{
    "connectionDetails": {
        "clusterName": "iltlvl231.dhcp.sap.corp",
        "port": "19011",
        "authentication": {
            "type": "user",
            "data": "lroot:<password>",
            "sslEnabled": "true"
        }
}