Monitor an active session
This method enables you to monitor an active PSM session using a connection method defined in the PVWA.
A response header defines which connection method is returned.
For details, see
URL
Make sure there are no spaces in the URL. The following characters are not supported in URL values: + & % |
|
|
The following mandatory value is required in the URL:
Parameter |
liveSessionID |
Type |
String |
Description |
The unique ID of the PSM session to monitor. |
Resource information
HTTP method |
GET |
Content type |
application/json |
Header parameter
Parameter |
Authorization |
|||||||||
Type |
String |
|||||||||
Description |
The token that identifies the session, encoded in BASE 64. |
|||||||||
Parameter |
Accept |
|||||||||
Type |
String |
|||||||||
Description |
The table below describes the expected response format depending on the value of the Accept header in the request, per connection method configuration (RDP File or PSM Gateway). |
|||||||||
|
|
Body parameters
None
Result
Response header
Parameter |
ConnectionMethod |
Type |
Boolean |
Description |
The method set in ConnectionType in the body parameters. |
Values |
PSMGW RDPFile |
Response body
There are two possible responses, depending on the connection method.
|
|
Parameter |
PSMGWURL |
Type |
String |
Description |
The full URL of the HTML5 gateway web server. |
Parameter |
PSMGWRequest |
Type |
String |
Description |
Base64 encoded data passed to the web server, essential for the actual web server HTML5 connection. This data is passed through the web server HTTP Post request. |
After receiving the PSMGW response, you can start a monitoring session via the PSM Gateway by sending a POST request to the URL specified in the response, in the PSMGWURL field.
Template:
|
The body of the POST request must contain the PSMGWRequest field obtained from the response.
Example:
|
Return codes
For a complete list of return codes, see Return Codes.