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

GET sessions

Get a list of defined AP session names.

Query Options

These HTTP query strings can be added to the URI to control the volume of returned URIs. Most query options represent properties of the object that are returned in the reply document. To see the definitions of those properties, you can read the schema documentation for the reply document.

SessionName=

The AP session name. A pattern-matching expression can be used to match session names.

SystemName=

The AP system name field. A pattern-matching expression can be used to match system names.

ConsoleType=

The type of console that is used by the session. The valid values are:

Terminal=

The terminal used by the session. The valid values are:

Automated=

Indicates the automation status. Valid values are:

yes

The session is currently being automated.

paused

Automation on the session has been explicitly paused.

no

The session is not automated by configuration and cannot be dynamically automated.

Connected=

Indicates the state of the connection to the monitored host. Valid values are: yes and no.

Count=

Maximum number of session IDs to be returned in this request. The highest value that can be set for this option is 100000. If this option is not specified a default value of 10000 is used.

FromCount=

The numeric count within your selected query from which sessions are included in your reply. The first position is numbered 1. Each successive position is incremented by one. The FromCount option can be used to retrieve a few sessions at a time, repeatedly.

Example:

This example shows retrieving sessions in groups of 10, using a sequence.

    get .../sessions?Count=10
    get .../sessions?Count=10&FromCount=11
    get .../sessions?Count=10&FromCount=21
    and so on.

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 sessions to be returned. Any session for which the user does not have at least VIEW privilege, is not returned in the list.

HTTP Response Headers

Status

Successful result = 200 = Ok

Successful Reply Document

SessionList in schema SessionList.xsd

This reply contains a list of customer-assigned session names for existing sessions. This reply includes the URIs used to access those sessions, for example:

https://localhost:8443/apwebsvc/sessions/sessionName1,
https://localhost:8443/apwebsvc/sessions/sessionName2, and so on.