Web Service API › Customer Defined Sessions › URI https://localhost:8443/apwebsvc/sessions/<sessionName> › GET sessions/<sessionName>

GET sessions/<sessionName>

Get the properties of a specific session.

Query Options

None

Request Document

None

HTTP Request Headers

Authorization

Supply a user ID and password in the HTTP Basic Authentication format. The user ID must be a user account with the AP Remote Viewer VIEW privilege on the session that is the target of this HTTP method.

HTTP Response Headers

Status

Successful result = 200 = Ok

Successful Reply Document

Session in schema Session.xsd

The reply returns the properties of the specified session, for example, SessionName, ConsoleType, and Automated.

A DeviceDetails property contains a URI to another resource. This resource contains details that are specific to the type of device that is used to make the connection to the monitored host. The URI points to an additional subnode of the AP URI hierarchy underneath the current sessionName node. The new subnode has one of the following three values:

…/apwebsvc/sessions/<sessionName>/TN3270
…/apwebsvc/sessions/<sessionName>/TN5250
…/apwebsvc/sessions/<sessionName>/Asynchronous

A Type attribute supplies information about the type of connection. A GET operation against such a subnode URI returns different properties which are characteristic of the type of connection. Details about the properties of each of these URIs are described later in this document.