Change the properties of a specific session.
These HTTP query strings can be added to the URI to control the order in which the desired changes are made.
The property names Automated and Connected are listed in the order in which their values will be changed. The property names are separated by commas. Both property names must be specified, or the PUT method returns an error. When an Order option is not specified, the order the properties are changed follows this specified query string:
PUT …/<sessionName>?Order=Automated,Connected
Session in schema Session.xsd
The request contains the requested state for this specified session. Currently only the Connected and Automated session properties can be modified. Any other differences between the current state and the data in the request document are ignored. When the current Automated state is no then it cannot be changed because the session is not configured to be automated. In addition, the Automated state cannot be changed from yes or paused to no.
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 FULL privilege on the session that is the target of this HTTP method.
Successful result = 200 = Ok
A successful status is only returned when all changes are successful. Otherwise, an error is returned and error details are provided in a WSResult document. A subsequent GET operation can also be performed on the session to identify properties that were not changed to the desired values.
None
|
Copyright © 2014 CA Technologies.
All rights reserved.
|
|