Live sessions (REST)

As described in Usage of Sessions, there are two different approaches creating a stored PurePath session. If you use the Store Session request, all PurePaths of the current live session are dumped to a stored PurePath session.

You can also record all incoming PurePaths by issuing Start Recording and Stop Recording requests.

Store session

Use the Store Session request to store all time series and PurePaths in the Server's memory to a stored session. To limit the data to be stored, specify a start time and end time.

The timeframe parameters must be formatted according to ISO 8601, without a time zone specification, in the form yyyy-MM-dd'T'HH:mm:ss or yyyy-MM-dd'T'HH:mm:ss.S. See the examples below. The timeframe parameters always relate to Server time. If one of the timeframe parameters is not available or is not formatted as expected, the last 30 minutes is stored.

GET https://<server>:8021/rest/management/profiles/<profilename>/storepurepaths Produces text/xml

Start session recording

Use this request to start session recording for a specific System Profile:

POST https://<server>:8021/rest/management/profiles/<profilename>/startrecording Consumes application/x-www-form-urlencoded

Produces text/xml

Stop session recording

Use this request to stop session recording:

GET https://<server>:8021/rest/management/profiles/<profilename>/stoprecording Produces text/xml

This call completes when until all recorded data is fully processed on the Server. Depending on the environment, it can take a few minutes until an HTTP response message is received.


This section contains deprecated live session REST interfaces, which should not be used. ## Clear session


Deprecated. To prevent breaking scripts it returns success without an action (as long as the default configuration for continuous recording is active)

GET https://<server>:8021/rest/management/profiles/<profilename>/clear Produces text/xml