Previous Topic: URI https://localhost:8443/apwebsvc/intsessionsNext Topic: OPTIONS intsessions


GET intsessions

Get a list of defined AP internal sessions.

Query Options

The following 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 internal session name. A pattern-matching expression can be used to match session names.

Count=

Maximum number of items the request returns. 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:

The following example shows retrieving internal sessions where names contain X:

get .../intsessions?SessionName=*X*
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 internal sessions to be returned. Any internal session that 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

InternalSessionList in schema InternalSessionList.xsd

The reply contains a list of internal session names for defined/enabled internal sessions. This reply includes the URIs used to access their details, for example:

https://localhost:8443/apwebsvc/intsessions/AXC, https://localhost:8443/apwebsvc/intsessions/VOX,
and so on.